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,docs-utils)!: extract out ToC type #3397

Merged
merged 3 commits into from
Jan 7, 2025

Conversation

griest024
Copy link
Member

BREAKING CHANGE: the ToC types have been trimmed up to only have fields used

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 new behavior?

  • extract ToC into its own type
  • remove an unnecessary nesting of ToC data
  • remove a lot of unused data from JSON documents

Does this PR introduce a breaking change?

[x] Yes
[ ] No

DaffGuideDoc.tableOfContents has a different type, the json nesting has been removed.

Other information

BREAKING CHANGE: the ToC types have been trimmed up to only have fields used
@griest024 griest024 added package: docs-utils @daffodil/docs-utils tools: dgeni @daffodil/tools-dgeni labels Jan 7, 2025
@griest024 griest024 self-assigned this Jan 7, 2025
@griest024 griest024 requested review from a team as code owners January 7, 2025 21:35
@griest024 griest024 merged commit 0db48b5 into graycoreio:develop Jan 7, 2025
11 checks passed
@griest024 griest024 deleted the feat/dgeni/extract-toc branch January 9, 2025 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: docs-utils @daffodil/docs-utils tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant