astrochili / astrochili/defold-annotations

Annotation typos and outdated meta information

Open
#4 28 comments 3 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
Lua
Stars
59
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Fixing annotation typos and outdated meta information requires edits to the [Defold source code](https://github.com/defold/defold/tree/master/engine), as this is the main source of documentation generation.

This issue is an attempt to collect that kind of bugs in one place and prepare pull requests to Defold batchwise. So feel free to share any annotation issues here. It will be more useful than fixing these bugs locally or just ignoring them.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the Defold engine source linked in the issue, since it is the source for generated documentation. Look for annotation typos and outdated meta information, then collect concrete findings and prepare a batch pull request; the issue does not name specific files or tests.

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.