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(dgeni,daffio): consolidate docs list rendering and generation #2989

Merged

Conversation

griest024
Copy link
Member

@griest024 griest024 commented Aug 15, 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?

The API and guides docsgen and rendering are very similar and duplicated

What is the new behavior?

The API and guides have a DRY docsgen and rendering

  • the nav list generation in dgeni has been combined into a single processor with a configured transform
  • the guides and API nav lists now have a unified type for wider compatiblity
  • the path configurators are now unified between API and guides
  • the docs service is no longer responsible for fetching nav lists and this is now handled by an index service
  • the guides and API lsit components have been combined

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@griest024 griest024 added package: daff.io @daffodil/daff.io tools: dgeni @daffodil/tools-dgeni labels Aug 15, 2024
@griest024 griest024 self-assigned this Aug 15, 2024
@griest024 griest024 requested review from a team as code owners August 15, 2024 18:24
@griest024 griest024 force-pushed the feat/daffio/consolidate-list-rendering branch from 853d2a1 to 4f2c4e6 Compare August 15, 2024 19:55
@griest024 griest024 merged commit 4f2c4e6 into graycoreio:develop Aug 15, 2024
3 of 4 checks passed
@griest024 griest024 deleted the feat/daffio/consolidate-list-rendering branch August 15, 2024 19:56
@gray-bot gray-bot mentioned this pull request Aug 15, 2024
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 tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant