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(all): integrated documentation using canonical MkDocs template #2726

Merged
merged 4 commits into from
Oct 4, 2023
Merged

Conversation

VRamakrishna
Copy link
Contributor

  • Moved old docs folder containing source files for legacy Cactus documentation to docs-cactus.
  • Created new docs folder using the MkDocs template specified in https://github.com/tkuhrt/documentation-template as the base.
    • Created overview files with useful links, diagrams, and references, for new and existing users
    • Migrated older Cactus and Weaver documentation for getting hands-on with code and samples to the new website, available through separate tabs
    • Fixed formatting, image references and other URLs, and organization
    • Created several stub files with temporary links, to be filled and expanded upon in due course, drawing on content already present in the above legacy documents
  • Added a GitHub action to automatically push the documentation build (generated using mkdocs) to the gh-pages branch, and then publish those the hyperledger organization's GitHub page for Cacti.
  • Updated Discord handles for maintainers in the MAINTAINERS.md file.
  • Fixed formatting typos in old doc files.

@VRamakrishna
Copy link
Contributor Author

Please comment here if you would like to add or remove pages from the current website (sample: https://vramakrishna.github.io/cacti/).

There's a lot more we need to do to enhance this website, including filling in content wherever needed, removing redundant content, reorganizing the Cactus and Weaver pages into a common set of pages where we show how the different Cacti packages and transaction pipelines can be instantiated and tested, and providing more detailed info on releases and roadmap.

For these, I think we can open issues and divide tasks among ourselves. For now, let us publish the documentation, just making sure there is no incorrect or misleading info there.

Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@VRamakrishna LGTM, thank you very much for working on the merged documentation!

Copy link
Contributor

@izuru0 izuru0 left a comment

Choose a reason for hiding this comment

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

LGTM!

@petermetz petermetz enabled auto-merge (rebase) October 4, 2023 05:39
…mage

Updated Discord handles in MAINTAINERS.md.
Added a Cactus legacy architecture diagram for reference.
Fixed formatting in old Weaver docs bullet lists.

Signed-off-by: VRamakrishna <[email protected]>
Also added a GitHub action to push built docs to 'gh-pages' branch,
and then publish those docs to the organization's GitHub pages.

Signed-off-by: VRamakrishna <[email protected]>
@petermetz petermetz merged commit 8840767 into hyperledger-cacti:main Oct 4, 2023
51 of 72 checks passed
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.

3 participants