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

Use a "real" documentation tool/site #9

Closed
WorldMaker opened this issue Feb 14, 2022 · 2 comments
Closed

Use a "real" documentation tool/site #9

WorldMaker opened this issue Feb 14, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@WorldMaker
Copy link
Owner

Rather than continue to expand the README until it scrolls for days. Maybe TypeDoc or DocFx?
@WorldMaker WorldMaker added the documentation Improvements or additions to documentation label Feb 14, 2022
@WorldMaker
Copy link
Owner Author

DocFX deploy to Github pages example workflow: /~https://github.com/jbltx/DiscordFX/blob/master/.github/workflows/deploy-to-github-pages.yml

@WorldMaker
Copy link
Owner Author

Discord-like theme for DocFx looks nice to me: /~https://github.com/jbltx/DiscordFX/

@WorldMaker WorldMaker mentioned this issue Feb 16, 2022
Closed
@WorldMaker WorldMaker linked a pull request Feb 21, 2022 that will close this issue
Add a basic documentation site #24
Merged
@WorldMaker WorldMaker removed a link to a pull request Feb 21, 2022
Add a basic documentation site #24
Merged
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@WorldMaker