caddyserver / caddyserver/website
Building website with custom module docs
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 227
- Forks
- 213
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 1
Description
Hi again!
Is there any documentation on how to build the website and have it reflect documentation for custom modules in the "JSON Config Structure"? I've found the moduledoc project, but haven't quite figured how to generate the desired output and marry it with the website content.
If someone is kind enough to give me a few breadcrumbs, maybe I can find the time to document and share the process (if it isn't already).
Thanks again for the phenomenal projects! They're becoming more and more critical to my work with each passing day.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the moduledoc project and the website's JSON Config Structure documentation. Trace how the website is built and how moduledoc output could be incorporated for custom modules. Done means documenting a reproducible process for generating and integrating the desired website content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100