Skip to content

Commit

Permalink
Merge pull request #1349 from ipopescu/927_contribute
Browse files Browse the repository at this point in the history
927 - Highlight ways to contribute to the docs
  • Loading branch information
ipopescu authored Dec 27, 2023
2 parents d02cb7c + 7b7dceb commit 2ed03d3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion DEVELOPERS.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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).
2 changes: 1 addition & 1 deletion config/navbar.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTE.md → writing-style-guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing Documentation
# Writing Style Guide

This is the Writing Style Guide used by Casper's documentation team.

Expand Down

0 comments on commit 2ed03d3

Please sign in to comment.