From 7b7dceb6c7d053a4dd830e4c33c11b3ba416f5c1 Mon Sep 17 00:00:00 2001 From: ipopescu Date: Fri, 22 Dec 2023 22:32:23 +0100 Subject: [PATCH] Highlight ways to contribute to the docs --- DEVELOPERS.md | 2 +- README.md | 10 +++++----- config/navbar.config.js | 2 +- CONTRIBUTE.md => writing-style-guide.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) rename CONTRIBUTE.md => writing-style-guide.md (99%) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index adb091ec1b..9b9652846e 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -1,6 +1,6 @@ # Casper Documentation Developer Guide -If you want to add new content or make structural updates to the documentation, follow this guide. +If you want to add new content or make structural updates to the documentation, follow this guide. Also, read the [Writing Style Guide](./writing-style-guide.md). ## Technology Stack diff --git a/README.md b/README.md index 6ce86fbaa4..ba968e3cff 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Welcome to the documentation website for the [Casper Network](https://casper.network/). The documentation lives at this address: https://docs.casper.network/. -Information on writing style guidelines for documentation can be found in [CONTRIBUTE.md](./CONTRIBUTE.md). +Read this page to learn how to contribute new content and run the documentation website locally. ## Setup @@ -17,7 +17,7 @@ Follow these steps to run the documentation website locally, displayed in your l - Install `yarn` via `npm` using this command: ``` - npm install --global yarn + npm install --global yarn ``` ### Running the website locally @@ -48,12 +48,12 @@ The following section details how to [update the content](#updating-existing-con ### Updating existing content 1. Navigate to the `source/docs/casper` folder. -2. Find the content you want to update and modify the markdown file(s). If you want to add new content, read the [Developer Guide](#developer-guide). +2. Find the content you want to update and modify the markdown file(s). If you want to add new content, read the [Developer Guide](./DEVELOPERS.md) and the [Writing Style Guide](./writing-style-guide.md). 3. [Run the website locally](#running-the-website-locally) to test your changes. 4. Submit changes to the [documentation](https://github.com/casper-network/docs) using a pull request from your forked repository. -**Note**: The website refreshes as you make changes to the markdown files. However, if you change the structure or configuration of the website, you need to re-start the application. +**Note**: The website refreshes as you change the markdown files. However, if you change the structure or configuration of the website, you need to restart the application. ### Adding new content -Adding new content requires structural changes, so read the [Developer Guide](./DEVELOPERS.md). +Adding new content may require structural changes. Read the [Developer Guide](./DEVELOPERS.md) and the [Writing Style Guide](./writing-style-guide.md). diff --git a/config/navbar.config.js b/config/navbar.config.js index 13b240c3f9..c38034a11b 100644 --- a/config/navbar.config.js +++ b/config/navbar.config.js @@ -107,7 +107,7 @@ module.exports = { // ], // }, { - href: "https://github.com/casper-network/docs", + href: "https://github.com/casper-network/docs/blob/dev/README.md", label: "GitHub", position: "right", }, diff --git a/CONTRIBUTE.md b/writing-style-guide.md similarity index 99% rename from CONTRIBUTE.md rename to writing-style-guide.md index 1c3c9e8b1b..655713155d 100644 --- a/CONTRIBUTE.md +++ b/writing-style-guide.md @@ -1,4 +1,4 @@ -# Contributing Documentation +# Writing Style Guide This is the Writing Style Guide used by Casper's documentation team.