generated from Lerking/python-repo-template
Upload files to "wiki"
This commit is contained in:
@@ -0,0 +1,33 @@
|
|||||||
|
# <Project Name> Wiki
|
||||||
|
|
||||||
|
> Copy the pages in this `wiki/` folder into your repository's actual GitHub Wiki (or your
|
||||||
|
> wiki tool of choice), then fill them in. File names map to page titles, so keep them as-is
|
||||||
|
> unless you're renaming the page. Delete this note once the wiki is populated.
|
||||||
|
|
||||||
|
Welcome. This wiki is the living documentation for the project — the specification and value
|
||||||
|
stream map describe what we set out to build and why; this wiki describes how the project
|
||||||
|
actually works and how to use it, day to day.
|
||||||
|
|
||||||
|
## Pages
|
||||||
|
|
||||||
|
- **[[Getting Started]]** — install, configure, and run the project locally
|
||||||
|
- **[[Architecture]]** — how the system is put together and why
|
||||||
|
- **[[Project Specification]]** — link/summary of the approved specification
|
||||||
|
- **[[Value Stream Mapping]]** — link/summary of the current & future state maps
|
||||||
|
- **[[FAQ]]** — common questions and troubleshooting
|
||||||
|
|
||||||
|
## Quick links
|
||||||
|
|
||||||
|
| | |
|
||||||
|
|---|---|
|
||||||
|
| Repository | `<link>` |
|
||||||
|
| Issue tracker | `<link>` |
|
||||||
|
| Project specification | [docs/PROJECT_SPECIFICATION.md](../docs/PROJECT_SPECIFICATION_TEMPLATE.md) |
|
||||||
|
| Value stream map | [docs/value-stream-mapping/](../docs/value-stream-mapping/) |
|
||||||
|
| CI / build status | `<link>` |
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Branching model: `<e.g. trunk-based, git-flow>`
|
||||||
|
- Commit message style: `<e.g. Conventional Commits>`
|
||||||
|
- Where decisions get recorded: `<e.g. ADRs in docs/adr/, this wiki, issue comments>`
|
||||||
Reference in New Issue
Block a user