...
Apparently, Sphinx can also support custom CSS and JS- thus further customization could be performed. However, the caveat being that this customization would need to be synced up between projects. If different projects used different layouts, functionality it defeats the purpose of standardization.
Questionnaire For Hyperledger Documentation
This questionnaire is meant to promote discussion regarding layout, accessibility, features and use-cases around Hyperledger documentation.
Questionnaire: Hyperledger project documentation
What features are most relevant to your project documentation page?
- Quick Start / Example Projects
- Key product features and functionality
- The ability for the user to spin up an instance
- All of the above
What visual layout or aesthetic style is the best choice for your Hyperledger documentation page?
- Simple, plain visual layout
- A current / modern look and feel
- Visually stunning layout with more color options
- Visual Layout is not relevant to my documentation page
Are there any features you would like to add to your project documentation page?
- Buttons to allow for ease of use
- Tables, graphs, charts or explanatory design documents
- Styling, aesthetic or layout features
- Social Media links / Hyperledger community links
- None of the above
- All of the above
How important are unique style elements to your project for documentation usage?
- Uniqueness is very important for product adoption
- Medium amount of importance
- Not very important, end users don't need unique style for documentation usage
Are there any features you would like to remove from your project documentation page?
- Yes, I would remove some features
- No, the documentation has no extraneous data
What content do you think is most important on a documentation page?
- Introduction to the actual product itself
- A Quick Start / Example Project
- Key Concepts (section / paragraph style explanations)
- Glossary of Key Terms
- Code Snippets / Code Examples
- All of the above
Where you like your project documentation to be stored?
- Readthedocs (current platform)
- Another documentation platform
- I don’t have a preference
What layout do you prefer for your documentation landing page?
- Small concepts that link to details
- Many concepts that comprehensively reflect the project
- No preference as to layout
From an end-user experience, do you think your page is visited by mostly one or more of the following?
- Business-facing users / General purpose users
- Developers / Technical Users
How much customization do you prefer for your documentation?
- Plain, not much customization
- A bit, but generic themes are ok
- I want in depth personalization and customization
How important are charts, graphs, and other visual documentation components?
- Very important for product adoption
- Medium amount of importance
- Not very important
Does your documentation page include Provide alt text or descriptions for non-text content (images)?
- Yes our page is fully accessible to persons with disabilities
- No, upgrades or additions can be made to img tags with alt text