beyond-all-reason / beyond-all-reason/RecoilEngine
[Docs] Support versioning between latest stable and pre-release
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 683
- Forks
- 293
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 40
Description
Make it so that documentation for both information retrieved from the binary (config vars, unsynced commands, etc) and from the source code (Lua API) is versioned between latest stable release and last pre-release.
Port the logic present in https://vsoch.github.io/docsy-jekyll/ to our template
Contributor guide
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 studying the linked docsy-jekyll implementation, then locate this repository's documentation template and the entry points that generate binary-derived config vars, unsynced commands, and the Lua API documentation. Done means both sources are versioned between the latest stable release and the last pre-release, matching the referenced behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100