Skip to content

Give the Unstable Book a title #59554

Closed
Closed

Description

@frewsxcv

Similar to rust-lang/rfcs#2669, but for the Unstable Book

Right now, titles look like: <title>emit_stack_sizes - </title>

To do this, we might just need to add a book.toml file in this directory

Activity

  1. added
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on Mar 30, 2019
  2. added
    E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
    C-enhancementCategory: An issue proposing an enhancement or a PR with one.
    on Mar 30, 2019
  3. gruberb commented on Mar 30, 2019

    @gruberb

    I created a PR for this issue. The title I added is "The Rust Unstable Book". Or should it just be "The Unstable Book"?

  4. frewsxcv commented on Mar 30, 2019

    @frewsxcv
    ContributorAuthor

    What you have looks great, thanks!

  5. added 2 commits that reference this issue on Mar 30, 2019
  6. frewsxcv commented on Apr 4, 2019

    @frewsxcv
    ContributorAuthor

    Looks like there's still no title set after #59569 🤔

  7. gruberb commented on Apr 4, 2019

    @gruberb

    Hmm... I'll check later when I am
    home!

  8. gruberb commented on Apr 4, 2019

    @gruberb

    @frewsxcv I double checked and it seems it's not being able to compile since there is no SUMMARY.md. When I run it locally the title is there, but the index is empty.

    So I'll add a SUMMARY.md and create a new PR.

  9. frewsxcv commented on Apr 4, 2019

    @frewsxcv
    ContributorAuthor

    It's been a while since I looked at this code, so not entirely sure how it all works, but I think the summary.md file is generated here: https://github.com/rust-lang/rust/tree/master/src/tools/unstable-book-gen/src

  10. gruberb commented on Apr 4, 2019

    @gruberb

    I see. I took inspiration from the other books (like embedded). When I reproduce it for the unstable book, I get the title and everything.

    So maybe I just have to add the book.toml to the unstable-book-gen folder. I never touched the books before so I am not sure why the unstable book behaves differently.

  11. ehuss commented on Apr 5, 2019

    @ehuss
    Contributor

    @gruberb The unstable book is generated by a tool (unstable-book-gen) which processes and copies the files from src/doc/unstable-book to build/*/md-doc/unstable-book and then mdbook is run against that folder to save the output to build/*/doc/unstable-book.

    I would probably edit unstable-book-gen to copy the book.toml file over along with the source files.

  12. added 4 commits that reference this issue on Apr 12, 2019
  13. frewsxcv commented on Apr 15, 2019

    @frewsxcv
    ContributorAuthor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions