jangala-dev / jangala-dev/lua-fibers

Research Documentation with EmmyLua and Implement Static Checking

Open
#34 0 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Description
This task involves two key objectives:

1) Research: Investigate how EmmyLua could be used to support documentation generation for Lua projects. Document findings, determine feasibility, and propose an approach if applicable.
* While researching, refer to the following related documentation issues for context and alignment:
* [Issue #31: Improve Documentation Standards](https://github.com/jangala-dev/lua-fibers/issues/31)
* [Issue #7: Investigate Tools for Lua Documentation](https://github.com/jangala-dev/lua-fibers/issues/7)
2) Implementation: If deemed appropriate based on the research, implement EmmyLua for static checking, starting with Lua fibers.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.