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

docs: update generated docs to include version in module names #296

Merged
merged 1 commit into from
Nov 2, 2023

Conversation

achingbrain
Copy link
Member

@achingbrain achingbrain commented Oct 30, 2023

Updates to latest aegir version with simplified readmes, auto-copying @packageDocumentation to "About" section and includes version numbers in the module versions.

image

Updates to latest aegir version with simplified readmes, auto-copying
@packageDocumentation to "About" section and includes version numbers
in the module versions.
Copy link
Member

@SgtPooki SgtPooki left a comment

Choose a reason for hiding this comment

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

So with this change, we wont have TOC in READMEs anymore, but we get auto generated About sections based on the @packageDocumentation for packages in each subpackage of a monorepo?

@achingbrain
Copy link
Member Author

Yes - in the generated docs we have a TOC on the right already so it's redundant:

image

we get auto generated About sections based on the @packageDocumentation for packages in each subpackage of a monorepo

Also yes, with the slight caveat that we have to run npm run docs to update it.

@achingbrain achingbrain merged commit 0776106 into main Nov 2, 2023
15 checks passed
@achingbrain achingbrain deleted the docs/update-generated-docs branch November 2, 2023 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants