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

Conversation

coriolinus
Copy link
Contributor

Closes #1195.

Break the implementors' guide into chapters organized with mdBook. Hopefully this can be merged quickly to minimize the amount of changes which accumulate based on the old guide.md.

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
It is redundant and unnecessary. Descriptions fall directly under the
top-level header for any given section.
@coriolinus coriolinus added A0-please_review Pull request needs code review. B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. labels Jun 11, 2020
@coriolinus coriolinus requested a review from rphmeier June 11, 2020 13:56
@coriolinus coriolinus self-assigned this Jun 11, 2020
@parity-cla-bot
Copy link

It looks like @coriolinus signed our Contributor License Agreement. 👍

Many thanks,

Parity Technologies CLA Bot

@coriolinus coriolinus changed the title Prgn guide mdbook Convert guide from single markdown file to mdbook Jun 11, 2020
@coriolinus
Copy link
Contributor Author

Thanks!

... I don't have permission to merge in this repo.

@coriolinus coriolinus merged commit e5c7a3e into master Jun 11, 2020
@coriolinus coriolinus deleted the prgn-guide-mdbook branch June 11, 2020 15:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Guide: it's big, and getting bigger. Should we use mdBook or similar to organize it?
3 participants