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

Docgen / API Docs integration; re-write Druxt Docgen as script. #137

Closed
Tracked by #93
Decipher opened this issue Aug 14, 2021 · 0 comments
Closed
Tracked by #93

Docgen / API Docs integration; re-write Druxt Docgen as script. #137

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

Comments

@Decipher
Copy link
Member

Decipher commented Aug 14, 2021 •
edited
Loading

Is your feature request related to a problem? Please describe.
As all packages are now in the mono-repo, the documentation needs to be updated for the mono-repo.

Describe the solution you'd like
Rewrite Druxt Docgen as a script that creates MDX API docs from the packages.

Describe alternatives you've considered
N/A

Additional context
https://github.com/druxt/druxt-docgen

Jiti: https://github.com/unjs/jiti
OCLIF: https://oclif.io/docs/introduction.html
Vue Docgen: https://www.npmjs.com/package/vue-docgen-api
@Decipher Decipher mentioned this issue Aug 14, 2021
Closed
6 tasks
@Decipher Decipher added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 14, 2021
Decipher added a commit that referenced this issue Aug 20, 2021
@Decipher
chore(#137): migrate docgen repository
dddfce5
Decipher added a commit that referenced this issue Aug 20, 2021
@Decipher
chore(#137): wip
efc8cdc
Decipher added a commit that referenced this issue Aug 20, 2021
@Decipher
chore(#137): wip
ba39265
Decipher added a commit that referenced this issue Aug 20, 2021
@Decipher
chore(#137): wip
bba590d
Decipher added a commit that referenced this issue Aug 20, 2021
@Decipher
refactor(#137): rewrite docgen
14ef3f1
Decipher added a commit that referenced this issue Aug 20, 2021
@Decipher
chore(#137): add docgen to gitpod task
b641d8a
@Decipher Decipher mentioned this issue Aug 31, 2021
Closed
Decipher added a commit that referenced this issue Aug 31, 2021
@Decipher
chore(#137): add changeset
9a6dc4e
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