To improve the navigability and UX of documentation.cash, I would like to set up Material for MkDocs as the static site generator. Using Material for MkDocs will:
Help users navigate and search for content.
Automate the navigation tree.
Allow for flexibility in the future, with the many plugins available for MkDocs.
I've already set up an instance locally based on the contents in this repository and done a bit of testing. Everything seems to run fine, and links seem to work properly as well without modification.
In scope
Setting up Material for MkDocs as the static site generator.
Running the static site generator on GitHub Pages (or somewhere else if specified).
Applying Bitcoin Cash colors for branding
Moving around folders and files.
Necessary for Material for MkDocs to recognize and automatically create the navigation.
Creating new pages for consistency.
Some sections don't have a top-level "Overview" page whereas some sections do have that top-level page for the section.
Not in scope
Revising documentation.
Can tackle this later since improving navigation might uncover duplicate documentation or content on pages.
Questions
Does this sound like something I can help with? If so:
Is there anything I need to implement beforehand (e.g., specify where the site should be hosted if not on GitHub Pages)?
Hi all. I'd like to propose an update to documentation.cash.
Proposal
To improve the navigability and UX of documentation.cash, I would like to set up Material for MkDocs as the static site generator. Using Material for MkDocs will:
I've already set up an instance locally based on the contents in this repository and done a bit of testing. Everything seems to run fine, and links seem to work properly as well without modification.
In scope
Not in scope
Questions
Does this sound like something I can help with? If so: