RobLoach / RobLoach/raylib-lua-sol

Lua Documentation

Open
#14 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
120
Forks
22
Avg merge
50m
Merged PRs (30d)
1

Description

Build automated documentation around the Lua API. While it's the same as the C API, would be nice to list the functions and stuffs.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Lua API and the corresponding C API to identify the functions that need documenting. Determine where the project’s API documentation belongs and how it should be generated or updated. Done means the Lua functions are listed with documentation consistent with the C API.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.