Move api.md from Wiki to the mod repo
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 20
- Forks
- 31
- Avg merge
- 1m
- Merged PRs (30d)
- 9
Description
I hereby would like to request moving the api.md file from the wiki to the repo.
Wiki entries are GitHub-specific, thus not portable or accessible within git checkouts.
This also means that grep'ing for function names yields no documentation results. Modders first need to check the wiki, which might not be obvious.
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 locating api.md in the GitHub wiki and inspecting the pipeworks repository layout for the appropriate documentation location. Move the wiki content into the repository while preserving its API documentation, then verify that the file is available in a git checkout and can be found when searching for function names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100