From ef41b63db7ea815a224aa91bd8e5a7230fa5afd4 Mon Sep 17 00:00:00 2001 From: 0x29a Date: Wed, 17 May 2023 17:25:01 +0800 Subject: [PATCH] docs: add links to the doc for better read experience (#4258) add links to the doc and refine links for better read experience --- CONTRIBUTING.md | 2 +- README.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43ebefc477..c5b3ff7459 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Howdy! Usual good software engineering practices apply. Write tests. Write comments. Follow standard Rust coding practices where -possible. Use 'cargo fmt' and 'clippy' to tidy up formatting. +possible. Use `cargo fmt` and `cargo clippy` to tidy up formatting. There are soft spots in the code, which could use cleanup, refactoring, additional comments, and so forth. Let's try to raise the diff --git a/README.md b/README.md index ce6ec09d24..1b0164d5c0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ The Neon storage engine consists of two major components: - Pageserver. Scalable storage backend for the compute nodes. - Safekeepers. The safekeepers form a redundant WAL service that received WAL from the compute node, and stores it durably until it has been processed by the pageserver and uploaded to cloud storage. -See developer documentation in [/docs/SUMMARY.md](/docs/SUMMARY.md) for more information. +See developer documentation in [SUMMARY.md](/docs/SUMMARY.md) for more information. ## Running local installation @@ -238,9 +238,9 @@ CARGO_BUILD_FLAGS="--features=testing" make ## Documentation -[/docs/](/docs/) Contains a top-level overview of all available markdown documentation. +[docs](/docs) Contains a top-level overview of all available markdown documentation. -- [/docs/sourcetree.md](/docs/sourcetree.md) contains overview of source tree layout. +- [sourcetree.md](/docs/sourcetree.md) contains overview of source tree layout. To view your `rustdoc` documentation in a browser, try running `cargo doc --no-deps --open` @@ -265,6 +265,6 @@ To get more familiar with this aspect, refer to: ## Join the development -- Read `CONTRIBUTING.md` to learn about project code style and practices. -- To get familiar with a source tree layout, use [/docs/sourcetree.md](/docs/sourcetree.md). +- Read [CONTRIBUTING.md](/CONTRIBUTING.md) to learn about project code style and practices. +- To get familiar with a source tree layout, use [sourcetree.md](/docs/sourcetree.md). - To learn more about PostgreSQL internals, check http://www.interdb.jp/pg/index.html