Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation revision #9

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

hardingalexh
Copy link
Contributor

This PR is intended to capture a number of documentation revisions based on internal discussion. I expect this list to grow before merged in.

  • Reconfigure flow of initial docs to have separate "installation" and "about" pages
  • Create higher level "getting started" page
  • Add "examples" library of snippets

@hardingalexh hardingalexh self-assigned this Jan 29, 2024
@@ -10,19 +10,29 @@ export default {
text: 'Introduction',
collapsible: true,
items: [
{text: 'About', link: '/introduction/'},
{text: 'About', link: '/introduction/index'},

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The in-page nav is not properly indicating the active selection for the about item. I think it might be because this page is not called /introduction/about?

image

@@ -0,0 +1,165 @@
# Writing Filter Components
Writing filter components in Harness-Vue is easy thanks to Vue and Pinia. Filters in Harness-Vue as abstractions around a pinia store - but at their core, they have a getter (`getFilter`) and a setter (`setFilter`).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Writing filter components in Harness-Vue is easy thanks to Vue and Pinia. Filters in Harness-Vue as abstractions around a pinia store - but at their core, they have a getter (`getFilter`) and a setter (`setFilter`).
Writing filter components in Harness-Vue is easy thanks to Vue and Pinia. Filters in Harness-Vue are abstractions around a pinia store - but at their core, they have a getter (`getFilter`) and a setter (`setFilter`).

I believe there is a typo here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants