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.

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

Merged
merged 17 commits into from
Dec 1, 2021
Merged

docs: publish consolidated docs using mkdocs #42

merged 17 commits into from
Dec 1, 2021

Conversation

thephez
Copy link
Collaborator

@thephez thephez commented Nov 17, 2021

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:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

docs/prepare-docs.sh Outdated Show resolved Hide resolved
docs/docs/index.md Outdated Show resolved Hide resolved
@thephez thephez requested a review from shumkov November 30, 2021 16:39
Copy link
Member

@shumkov shumkov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

@shumkov shumkov added this to the v0.21.x milestone Dec 1, 2021
@thephez thephez merged commit 000be71 into master Dec 1, 2021
@thephez thephez deleted the mkdocs branch December 1, 2021 18:59
@thephez
Copy link
Collaborator Author

thephez commented Dec 1, 2021

@shumkov or @antouhou, this built successfully when merged and created the gh-pages branch (https://github.com/dashevo/platform/tree/gh-pages) necessary to MkDocs. IIRC, someone with access to the repo settings will still have to go in there and enable GitHub Pages before they will be published to https://dashevo.github.io/platform/.

Also, 000be71 should be integrated to the v0.22 branch.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants