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

feat(daffio): add design docs route #3113

Merged
merged 9 commits into from
Sep 26, 2024

Conversation

griest024
Copy link
Member

@griest024 griest024 commented Sep 23, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Part of: #2684

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[ ] No

Other information

#3112 is an issue but shouldn't block this PR

@griest024 griest024 added package: daff.io @daffodil/daff.io status: awaiting review This PR is awaiting review labels Sep 23, 2024
@griest024 griest024 requested a review from xelaint September 23, 2024 23:07
@griest024 griest024 requested review from a team as code owners September 23, 2024 23:07
Copy link
Member

@xelaint xelaint left a comment

Choose a reason for hiding this comment

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

Top nav should stay the same as the primary /docs nav, except Design needs to be added as a nav item, which navigates to docs/design

  • Examples is not going to be path that we'll be using since all examples will be housed within the overview tab.
  • Packages should be changed to Components
  • docs/design should be a custom page not rendered by a README. It's going to look something like this (I can do the UI for it, just needed the route set up)
Screen Shot 2024-09-24 at 11 57 29 AM
  • The API reference page for each component is going to be displayed in the form of a tab within the component page.
Screen Shot 2024-09-24 at 11 55 44 AM

@griest024 griest024 force-pushed the feat/daffio/design-docs branch from b9912ca to d2ddeef Compare September 25, 2024 18:37
@griest024 griest024 requested review from a team as code owners September 25, 2024 18:37
@griest024
Copy link
Member Author

@xelaint I've reworked the design docs structure to hopefully match your requirements. Note there are two issues that should be handled in future PRs and not block this one:

  • The order of items in the sidebar does not match the design. We need a good pattern for hardcoding tree order and sorting.
  • The docs don't have overview/API tabs. In a future PR, add a design for this and I will wire it up.

@griest024 griest024 requested a review from xelaint September 25, 2024 18:43
@xelaint xelaint requested a review from a team as a code owner September 25, 2024 20:36
@xelaint
Copy link
Member

xelaint commented Sep 25, 2024

@xelaint I've reworked the design docs structure to hopefully match your requirements. Note there are two issues that should be handled in future PRs and not block this one:

  • The order of items in the sidebar does not match the design. We need a good pattern for hardcoding tree order and sorting.
  • The docs don't have overview/API tabs. In a future PR, add a design for this and I will wire it up.

issues for these have been added, #3123 and #3124

xelaint
xelaint previously approved these changes Sep 26, 2024
@griest024 griest024 merged commit a3bf15a into graycoreio:develop Sep 26, 2024
15 checks passed
@gray-bot gray-bot mentioned this pull request Sep 25, 2024
@griest024 griest024 deleted the feat/daffio/design-docs branch September 26, 2024 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: daff.io @daffodil/daff.io status: awaiting review This PR is awaiting review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants