Add user manual content with structured sections and table of contents #8
Conversation
Sam-Max
commented
Apr 13, 2025
Sam-Max
commented
- Updated the site navigation to include a link to the new user manual under the Resources menu.
|
|
|
the manual/ directory inside content/ should be moved inside the content/resources/ directory so that it coresponds to putting it under the Resources menu item. |
hugo-site/content/_index.md
Outdated
| @@ -8,7 +8,7 @@ links: | |||
| text: "Video Talks" | |||
| icon: "fas fa-video" | |||
| color: "is-medium-blue" | |||
| - url: "https://docs.freenet.org/" | |||
| - url: "/manual/" | |||
There was a problem hiding this comment.
Should be /resources/manual
hugo-site/content/manual/README.md
Outdated
| @@ -0,0 +1,64 @@ | |||
| **NOTE:** This document is a work in progress. You can [submit an issue](https://github.com/freenet/freenet-core/issues/new?labels=A-documentation) if you find a problem or have a suggestion. The source for this documentation is in our repository at [freenet-core/docs/src](https://github.com/freenet/freenet-core/tree/main/docs/src). We welcome pull requests. | |||
There was a problem hiding this comment.
I don't think we need to copy this README.md file over.
hugo-site/hugo.toml
Outdated
| @@ -73,6 +73,12 @@ theme = "freenet" | |||
| name = "Contribute" | |||
| weight = 10 | |||
|
|
|||
| [[menu.main]] | |||
There was a problem hiding this comment.
I think you will also need to add menu entries for each of the pages in the manual, nested under the Manual section
- Updated the site navigation to include a link to the new user manual under the Resources menu.
…ction and a table of contents
hugo-site/hugo.toml
Outdated
| @@ -79,6 +79,12 @@ theme = "freenet" | |||
| weight = 14 | |||
There was a problem hiding this comment.
Shouldn't this be "/resources/manual/" to correspond to the directory structure under content/?
There was a problem hiding this comment.
It is fixed in the commit 2ec81f9, the last one, here I was playing with Aider, and it made that commit.
|
|
||
| Freenet contracts must implement the [`ContractInterface`](https://docs.rs/freenet-stdlib/latest/freenet_stdlib/prelude/trait.ContractInterface.html) trait: | ||
|
|
||
| ```rust |
There was a problem hiding this comment.
While this should change infrequently it would still be nice to pull it directly from the repo.
|
|
||
| Software that uses Freenet as a back-end. This includes native software | ||
| distributed independenly of Freenet but which uses Freenet as a back-end | ||
| (perhaps bundling Freenet), and [web applications](/manual/glossary#web-application) |
There was a problem hiding this comment.
Should be /resources/manual/...?
Sam-Max
changed the title
