Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Convert guide from single markdown file to mdbook #1247

Merged
merged 16 commits into from
Jun 11, 2020
Merged

Convert guide from single markdown file to mdbook #1247

merged 16 commits into from
Jun 11, 2020

Commits on Jun 11, 2020

  1. move old implementers' guide, add skeleton of new

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    f28681d View commit details
    Browse the repository at this point in the history

  2. 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
    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    ea7e49d View commit details
    Browse the repository at this point in the history

  3. remove description headers 

    It is redundant and unnecessary. Descriptions fall directly under the
top-level header for any given section.
    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    3e63039 View commit details
    Browse the repository at this point in the history

  4. add stub description of the backing module

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    ee686aa View commit details
    Browse the repository at this point in the history

  5. add stub description for the availability module

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    88b62e1 View commit details
    Browse the repository at this point in the history

  6. add stub description for collators

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    3138f52 View commit details
    Browse the repository at this point in the history

  7. add stub description for validity

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    d49fa30 View commit details
    Browse the repository at this point in the history

  8. add stub description for utility

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    f33e8ff View commit details
    Browse the repository at this point in the history

  9. highlight TODO and REVIEW comments

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    5d31ec2 View commit details
    Browse the repository at this point in the history

  10. add guide readme describing how to use mdbook

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    998cec2 View commit details
    Browse the repository at this point in the history

  11. fix markdownlint lints

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    18ca26a View commit details
    Browse the repository at this point in the history

  12. re-title parachains overview

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    2a2ea83 View commit details
    Browse the repository at this point in the history

  13. internal linking for types

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    6ef9bce View commit details
    Browse the repository at this point in the history

  14. module and subsystem internal links

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    c818040 View commit details
    Browse the repository at this point in the history

  15. .gitignore should have a trailing newline

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    186a2e6 View commit details
    Browse the repository at this point in the history

  16. node does not have modules, just subsystems

    @coriolinus
    coriolinus committed Jun 11, 2020
    Configuration menu
    Copy the full SHA
    9d4acb2 View commit details
    Browse the repository at this point in the history