Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mdbook-spec #1520

Merged
merged 9 commits into from
Jul 4, 2024
Merged

Add mdbook-spec #1520

merged 9 commits into from
Jul 4, 2024

Commits on Jul 2, 2024

  1. Start using mdbook-spec for the reference.

    This preprocessor adds support for several Markdown extensions that
    should assist with writing.
    ehuss committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    73fbd40 View commit details
    Browse the repository at this point in the history
  2. Copy the spec authoring guide over verbatim.

    The next commit will update to keep in sync with the reference.
    ehuss committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    850cdf4 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    b5966e9 View commit details
    Browse the repository at this point in the history
  4. Update CI to use mdbook-spec

    ehuss committed Jul 2, 2024
    Configuration menu
    Copy the full SHA
    31555be View commit details
    Browse the repository at this point in the history

Commits on Jul 4, 2024

  1. Sort link section alphabetically

    This link section was already sorted but for a recent change (that
    understandably probably preferred to keep the diff contained).  Let's
    restore the sort order of the links here.
    traviscross committed Jul 4, 2024
    Configuration menu
    Copy the full SHA
    a7a9a69 View commit details
    Browse the repository at this point in the history
  2. Rewrap paragraph

    The CONTRIBUTING guide seems wrapped at 80 character lines.  Let's
    rewrap a paragraph with a line that had overflowed.
    traviscross committed Jul 4, 2024
    Configuration menu
    Copy the full SHA
    6c5c972 View commit details
    Browse the repository at this point in the history
  3. Follow the authoring guide in the authoring guide

    Let's follow our own rules in the authoring guide by, e.g., using
    `---` rather than the Unicode em-dash character, not wrapping lines,
    specifying the language for code block sections, etc.
    
    To improve formatting, we broke out some descriptions that were in
    code block sections into the main text.  We replaced references to
    "the spec" with "the reference" for consistency, as that's what most
    of this document uses.  And we made some other small editorial
    improvements.
    traviscross committed Jul 4, 2024
    Configuration menu
    Copy the full SHA
    b82955c View commit details
    Browse the repository at this point in the history
  4. Copy remaining style guidance to authoring guide

    These two items of style were the only bits present in the style guide
    and missing from the authoring guide.  Let's copy them over, since
    they are true of the Reference, and this will let us delete the style
    guide entirely.
    traviscross committed Jul 4, 2024
    Configuration menu
    Copy the full SHA
    1b57f6c View commit details
    Browse the repository at this point in the history
  5. Replace style guide with a link to the authoring guide

    The authoring guide now fully incorporates and supersedes the style
    guide, so let's simply link to that from the style guide.
    traviscross committed Jul 4, 2024
    Configuration menu
    Copy the full SHA
    d376cba View commit details
    Browse the repository at this point in the history