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

docs: move book to the docs folder #7682

Merged
merged 1 commit into from
Sep 23, 2022
Merged

Conversation

matklad
Copy link
Contributor

@matklad matklad commented Sep 23, 2022

docs feels like a much more self-explanatory name than book. I originally put the stuff into book folder to not mess up existing docs, but now that those are moved into the book, we can set up proper name.

This was the plan all along!

This also finalizes, for the time being

docs feels like a much more self-explanatory name than book. I
originally put the stuff into book folder to not mess up existing docs,
but now that those are moved into the book, we can set up proper name.

This was the plan all along!

This also finalizes, for the time being

* the name "Guide to Nearcore Development" (unispiringly stolen from
  https://github.com/rust-lang/rustc-dev-guide/blob/master/book.toml)
* the url https://near.github.io/nearcore/. We can add some fancier DNS
  here, but I don't see a big need here. I also hope that most links
  would be *internal* to the guide, so I wouldnt' worry about URL
  stability too much. This is by design not the reference doc!
@matklad matklad requested a review from akhi3030 September 23, 2022 12:02
@matklad matklad requested a review from a team as a code owner September 23, 2022 12:02
@matklad matklad merged commit 7a9a44c into near:master Sep 23, 2022
@matklad matklad deleted the m/docs-again branch September 23, 2022 14:20
nikurt pushed a commit that referenced this pull request Sep 26, 2022
docs feels like a much more self-explanatory name than book. I
originally put the stuff into book folder to not mess up existing docs,
but now that those are moved into the book, we can set up proper name.

This was the plan all along!

This also finalizes, for the time being

* the name "Guide to Nearcore Development" (unispiringly stolen from
  https://github.com/rust-lang/rustc-dev-guide/blob/master/book.toml)
* the url https://near.github.io/nearcore/. We can add some fancier DNS
  here, but I don't see a big need here. I also hope that most links
  would be *internal* to the guide, so I wouldnt' worry about URL
  stability too much. This is by design not the reference doc!
nikurt pushed a commit that referenced this pull request Nov 9, 2022
docs feels like a much more self-explanatory name than book. I
originally put the stuff into book folder to not mess up existing docs,
but now that those are moved into the book, we can set up proper name.

This was the plan all along!

This also finalizes, for the time being

* the name "Guide to Nearcore Development" (unispiringly stolen from
  https://github.com/rust-lang/rustc-dev-guide/blob/master/book.toml)
* the url https://near.github.io/nearcore/. We can add some fancier DNS
  here, but I don't see a big need here. I also hope that most links
  would be *internal* to the guide, so I wouldnt' worry about URL
  stability too much. This is by design not the reference doc!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants