Skip to content

Commit d39fe99

Browse files
Cleans up README with better contribution instructions.
1 parent 3a65830 commit d39fe99

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- [Information architecture](#information-architecture)
1414
- [Repository structure](#repository-structure)
1515
- [Support](#support)
16-
- [Contributions](#contributions)
16+
- [Contributions](#contribute)
1717
- [License](#license)
1818

1919
## Run locally
@@ -126,6 +126,13 @@ To submit a support ticket:
126126
127127
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.
128128
129+
### Writing docs
130+
131+
You can find all the docs in the `/content` folder. This content directory is structured the same as the website. The only caveats:
132+
133+
1. The `docs.entropy.xyz` homepage is controlled by `./content/_index.md`.
134+
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.
135+
129136
## License
130137
131138
- Most things in `/content` are licensed under [MIT](./LICENSE) unless otherwise specified.

0 commit comments

Comments
 (0)