-
Notifications
You must be signed in to change notification settings - Fork 7
[Prototype] Docs with Docusaurus #1111
base: master
Are you sure you want to change the base?
Conversation
NotesI had to create a number of scripts (not the best, can probably be cleaned up and/or improved if we go with this solution), since Docusaurus has its own Anyhoo, to test locally while developing the docs, you can run: $ npm run start:docs And head to view the docs locally at: To try a build of the docs within the Rogue test domain, run: $ npm run docs:dev Then head to view the docs locally at: Interesting note, when running a build, Docusaurus can check if the markdown files have any broken links and will throw errors if it finds any which seems super useful! The A couple troubleshooting notes, of issues I encountered... I had to increase the version of Node in our I also had an issue with Nginx on the Heroku Review Apps for the rendered docs and requires specifying |
What's this PR do?
This pull request is a prototype for a new documentation system we could use on some of our projects utilizing Docusaurus.
How should this be reviewed?
Casual 👀 just to see how it's implemented 😄
Any background context you want to provide?
This is a prototype demo for upcoming RFC.