Create project website
- Dominant language
- Go
- Stars
- 9.6k
- Forks
- 962
- Avg merge
- 23h 27m
- Merged PRs (30d)
- 48
Description
We have started to outpace the simple "all documentation goes in the README.md" approach that we take today. We should create a website that encompasses at least:
- installation
- basic usage
- document use cases
- document of configuration options
- integration examples and links
- links to communication (slack / issues)
- details on our bi-weekly community meeting
- high-level roadmap
We should leave / reserve `CONTRIBUTING.md`, `RELEASE.md`, and `DEVELOPING.md` (in-progress) outside of the site (in the root of the repo).
Contributor guide
Research direction
Start by reviewing README.md and the existing repository structure, including CONTRIBUTING.md, RELEASE.md, and DEVELOPING.md, to understand what content is already documented and what must remain outside the site. Done means a project website covers the listed installation, usage, configuration, integration, communication, meeting, and roadmap content while those three files remain in the repository root.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100