Skip to content

Commit

Permalink
Cleans up README with better contribution instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
johnnymatthews committed Aug 26, 2024
1 parent 3a65830 commit d39fe99
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- [Information architecture](#information-architecture)
- [Repository structure](#repository-structure)
- [Support](#support)
- [Contributions](#contributions)
- [Contributions](#contribute)
- [License](#license)

## Run locally
Expand Down Expand Up @@ -126,6 +126,13 @@ To submit a support ticket:
We appreciate contributions of any size from everyone, from fixing typos to proposing substantial rewrites to aid clarity. Simply make a PR with your edits, and a member of the Entropy devrel team will review everything.
### Writing docs
You can find all the docs in the `/content` folder. This content directory is structured the same as the website. The only caveats:
1. The `docs.entropy.xyz` homepage is controlled by `./content/_index.md`.
1. Section indexes, like `docs.entropy.xyz/concepts`, are automatically generated by Hugo -- you do not need to directly edit the content of these pages. The content in the sub-pages controls the page snippets in these index pages. For example, the snippet for the **Quickstart** entry in `docs.entropy.xyz/basics` is generated from the `lead` variable within `./content/basics/quickstart.md`. If a `lead` variable does not exist, Hugo generates a snippet from the main content of a sub-page.
## License
- Most things in `/content` are licensed under [MIT](./LICENSE) unless otherwise specified.
Expand Down

0 comments on commit d39fe99

Please sign in to comment.