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.

Sign up for GitHub

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

Jump to bottom

Generate API README.md from docgen #157

Closed
Decipher opened this issue Aug 26, 2021 · 0 comments
Closed

Generate API README.md from docgen #157

Decipher opened this issue Aug 26, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Decipher
Copy link
Member

Is your feature request related to a problem? Please describe.
As a maintainer I want an API README.md generated automatically with an overview of the codebase so I don't have to write it and maintain it.

Describe the solution you'd like
Output a README.md as part of the Docgen process with an overview of the packages, including information from the package.json.

Describe alternatives you've considered
No

Additional context
@Decipher Decipher added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 26, 2021
Decipher added a commit that referenced this issue Aug 28, 2021
@Decipher
feat(#157): add package list generator
6b26c1f
This was referenced Aug 28, 2021
Merged
Closed
Decipher added a commit that referenced this issue Aug 28, 2021
@Decipher
feat(#157): add package list generator (#163)
7aca43f
Decipher added a commit that referenced this issue Aug 28, 2021
@Decipher
feat(#157): add package list generator (#163)
36137c2
Decipher added a commit that referenced this issue Aug 30, 2021
@Decipher
chore(#150): add Documentation frontend (#155)
f059a4e 
* chore(#150): backup old documention

* chore(#150): add Nuxt

* feat(#150): add API docs NuxtContent page

* chore(#150): update gitpod config

* chore(#150): add yarn.lock

* chore(#150): add DaisyUI

* chore(#150): add WIP components

* chore(#150): update docs site components

* chore(#150): add telemetry setting

* chore(#150): swap windicss for tailwindcss

* feat(#150): add recent documents store

* chore(#150): update recent store

* chore(#150): update API components

* chore(#150): update API page and components

* feat(#150): add Guide pages and components

* chore(#150): update docs/api pages/components

* chore(#150): update layout

* chore(#150): update docs components

* feat(#150): add subnavigation

* fix(#150): fix plugin order

* chore(#150): update docs components

* feat(#150): add Google Analytics

* feat(#157): add package list generator (#163)

* chore(#150): update navigation components

* chore(#150): fix missing path

* chore(#150): update frontpage

* fix(#150): fix README in navigation

* chore(#150): update guide

* chore(#150): close menu on route change

* feat(#169): add doc generated components list (#170)

* chore(#150): close menu on route change

* feat(#169): add doc generated components list
@Decipher Decipher mentioned this issue Aug 31, 2021
Closed
Decipher added a commit that referenced this issue Aug 31, 2021
@Decipher
chore(#157): add changeset
70cf369
Decipher added a commit that referenced this issue Aug 31, 2021
@Decipher
chore(#188): add missing docgen changesets (#189)
604def9 
* chore(#137): add changeset

* chore(#157): add changeset

* chore(#169): add changeset
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Decipher