mt-mods / mt-mods/basic_materials

more documentation discussion

Open
#6 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation question
Dominant language
Lua
Stars
6
Forks
14
Avg merge
1m
Merged PRs (30d)
4

Description

  1. is content or documentation needed
  2. if 1 then should this repo use the wiki
  3. if not 1 then how should documentation be organized
  4. should it have examples on how to use submodules
  5. should it have a list of mods that use this mod
  6. profit?

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

Begin by reviewing the repository's current documentation and wiki status, then compare them with the questions in the issue. Determine whether usage examples for submodules and a list of mods using this mod belong in the documentation, and document the agreed organization and location.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.