Start moving internal documentation to /docs
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 2.8k
- Forks
- 334
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 50
Description
Tasks
- start a wiki
- move some low-hanging fruit(s) from internal docs to it (cross-ref new location from old)
- figure out and document a way to dump wiki into a tree of
*.md-files in/docsin this repo. (my first idea, possibly no fun or invalid: write a small shell script that pulls everything from the wiki, overwrites the working copy with the changes, and commits this to a branchdocs-<timestamp>.) - (optional?) figure out a way to sync
/docsback into wiki, should somebody prefer to work there.
for a light-weight process to keep wiki and /docs in sync: we can add "call that script" to the release procedure.
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 existing wiki, internal documentation, and the /docs directory. Define the scope for the initial migration, cross-reference moved pages from their old locations, and document the wiki-to-*.md export process. Done means the selected documentation is migrated and the release procedure records how to keep the locations in sync.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100