-
Notifications
You must be signed in to change notification settings - Fork 39
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: publish consolidated docs using mkdocs #42
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 👍
@shumkov or @antouhou, this built successfully when merged and created the Also, 000be71 should be integrated to the v0.22 branch. |
Issue being fixed or feature implemented
Given the changed project structure, it appears that docsify won't work in a monorepo format. Prior to having this monorepo, a number of its packages hosted documents on their own repository Github Pages sites (js-dapi-client, js-dash-sdk, js-dpp, and wallet-lib). These sites were built via docsify.
What was done?
I found MkDocs which accomplishes a similar purpose. While it doesn't directly support monorepos, I found it to be more flexible than docsify. This PR uses it, along with a GH action to publish an aggregated set of documentation for those 4 packages. Fortunately it works relatively well with no modification to the documentation source files.
How Has This Been Tested?
I experimented using a fork of this repo and deploying the resulting documentation on that repo's GH Pages site: https://thephez.github.io/platform/. There are a few broken links and malformed markdown in the existing files that will need to updated, but those changes
would be a separate PR after this is mergedhave been made in PR #49 .Breaking Changes
Checklist:
For repository code-owners and collaborators only