Add documentation/lua-docs
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Lua
- Stars
- 20
- Forks
- 31
- Avg merge
- 1m
- Merged PRs (30d)
- 9
Description
Add documentation for:
- tp-tube (modding-api and ingame-api)
- tag-tube (#107)
- embedded tube registration (modding-api)
- lua-tube events and interface (ingame)
- detector tubes (ingame)
- digiline injector (ingame)
(maybe in a api.md or in the repo readme itself)
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 modding and in-game API documentation, then decide whether the additions belong in api.md or the repository README. Document tp-tube, tag-tube, embedded tube registration, lua-tube events and interface, detector tubes, and the digiline injector; done means all six listed topics are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100