-
Notifications
You must be signed in to change notification settings - Fork 17
Open
Labels
Content RefactorAddressing existing content's inaccuracies or edits.Addressing existing content's inaccuracies or edits.Minor Infra RefactorFor minor changes regarding configuration of Docusaurus and its deployment.For minor changes regarding configuration of Docusaurus and its deployment.
Description
Below represents the current state of the respective courses, context, and proposed solutions for this repository.
It also illustrates what the future of this repo could look like, both structurally and in terms of the content held within.
Presumptions
- Both courses and guides can follow this common structure.
- It should be easy to create new guides and courses.
- We can continue to use docusaurus, but the theming/components will be crucial to maintain.
Problems
- Unclear where to start, both on the landing page and within the guides and courses.
- Landing page for each course (see: Substrate Intro Page)should have a common layout.
- Graphics (should be tackled early) - either use standard wiki graphics in grayscale, or make mermaid graphics nice to use.
- Need a template for contributing:
- Set a structure for guides or courses.
- A way to generate it quickly, ideally without too much manual labor.
Proposed Solutions (working draft)
- improve the main landing page, make it more "alive" (not priority)
- "Get Started" or "Explore" buttons on the frontpage
- Provide buttons further up to indicate different tracks - from protocol development to Polkadot "dapp development"
- Offer clear progression from the frontpage, "here is where we go to end up at the destination of X" (priority)
- Improve the mermaid/graphic situation - custom component that uses mermaid to match the wiki graphics?
- Standard components as someone is scrolling through the course for:
- Section objectives, page objectives
- Page summaries at the end of each portion
- Knowledge check ("what we learned so far"),
- Learn more for concepts (will probably point to the wiki)
Metadata
Metadata
Assignees
Labels
Content RefactorAddressing existing content's inaccuracies or edits.Addressing existing content's inaccuracies or edits.Minor Infra RefactorFor minor changes regarding configuration of Docusaurus and its deployment.For minor changes regarding configuration of Docusaurus and its deployment.