Convert guide from single markdown file to mdbook (#1247)
* move old implementers' guide, add skeleton of new * Split the old implementers' guide into the new one's sections This is mostly a straightforward copying operation, moving the appropriate sections from the old guide to the new. However, there are certain differences between the old text and the new: - removed horizontal rules between the sections - promoted headers appropriately within each section - deleted certain sections which were in the old guide's ToC but which were not actually present in the old guide. - added Peer Set Manager to the new ToC * remove description headers It is redundant and unnecessary. Descriptions fall directly under the top-level header for any given section. * add stub description of the backing module * add stub description for the availability module * add stub description for collators * add stub description for validity * add stub description for utility * highlight TODO and REVIEW comments * add guide readme describing how to use mdbook * fix markdownlint lints * re-title parachains overview * internal linking for types * module and subsystem internal links * .gitignore should have a trailing newline * node does not have modules, just subsystems
Showing
- polkadot/roadmap/implementors-guide/.gitignore 1 addition, 0 deletionspolkadot/roadmap/implementors-guide/.gitignore
- polkadot/roadmap/implementors-guide/README.md 9 additions, 0 deletionspolkadot/roadmap/implementors-guide/README.md
- polkadot/roadmap/implementors-guide/book.toml 6 additions, 0 deletionspolkadot/roadmap/implementors-guide/book.toml
- polkadot/roadmap/implementors-guide/guide.md 0 additions, 1830 deletionspolkadot/roadmap/implementors-guide/guide.md
- polkadot/roadmap/implementors-guide/src/README.md 5 additions, 0 deletionspolkadot/roadmap/implementors-guide/src/README.md
- polkadot/roadmap/implementors-guide/src/SUMMARY.md 42 additions, 0 deletionspolkadot/roadmap/implementors-guide/src/SUMMARY.md
- polkadot/roadmap/implementors-guide/src/architecture.md 83 additions, 0 deletionspolkadot/roadmap/implementors-guide/src/architecture.md
- polkadot/roadmap/implementors-guide/src/further-reading.md 4 additions, 0 deletionspolkadot/roadmap/implementors-guide/src/further-reading.md
- polkadot/roadmap/implementors-guide/src/glossary.md 34 additions, 0 deletionspolkadot/roadmap/implementors-guide/src/glossary.md
- polkadot/roadmap/implementors-guide/src/node/README.md 13 additions, 0 deletionspolkadot/roadmap/implementors-guide/src/node/README.md
- polkadot/roadmap/implementors-guide/src/node/availability/README.md 3 additions, 0 deletions...oadmap/implementors-guide/src/node/availability/README.md
- polkadot/roadmap/implementors-guide/src/node/availability/availability-distribution.md 41 additions, 0 deletions...-guide/src/node/availability/availability-distribution.md
- polkadot/roadmap/implementors-guide/src/node/availability/bitfield-distribution.md 25 additions, 0 deletions...tors-guide/src/node/availability/bitfield-distribution.md
- polkadot/roadmap/implementors-guide/src/node/availability/bitfield-signing.md 25 additions, 0 deletions...lementors-guide/src/node/availability/bitfield-signing.md
- polkadot/roadmap/implementors-guide/src/node/backing/README.md 10 additions, 0 deletions...dot/roadmap/implementors-guide/src/node/backing/README.md
- polkadot/roadmap/implementors-guide/src/node/backing/candidate-backing.md 92 additions, 0 deletions.../implementors-guide/src/node/backing/candidate-backing.md
- polkadot/roadmap/implementors-guide/src/node/backing/candidate-selection.md 39 additions, 0 deletions...mplementors-guide/src/node/backing/candidate-selection.md
- polkadot/roadmap/implementors-guide/src/node/backing/pov-distribution.md 13 additions, 0 deletions...p/implementors-guide/src/node/backing/pov-distribution.md
- polkadot/roadmap/implementors-guide/src/node/backing/statement-distribution.md 54 additions, 0 deletions...ementors-guide/src/node/backing/statement-distribution.md
- polkadot/roadmap/implementors-guide/src/node/collators/README.md 3 additions, 0 deletions...t/roadmap/implementors-guide/src/node/collators/README.md
Please register or sign in to comment