OpenTTD / OpenTTD/nml

Document stations

Open
#262 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
58
Forks
46
Avg merge
11d 15h
Merged PRs (30d)
3

Description

#244 added station support in nml.

We need docs for stations.

As very few like writing docs alone, we're trialling collaborative doc editing, then converting to wiki later:

https://docs.google.com/document/d/1NHXIqofmgeXbqRZhFhJN52dNV-zMYaZEAUFevDvp1qs/edit

I also checked if GRF specification page needs updated; I don't think it does as nothing changed in OpenTTD / grf spec https://wiki.openttd.org/en/Development/NewGRF/Specification%20Status

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 reading issue #244 and the linked collaborative Google document to understand the station support that needs documenting. Check the existing nml documentation and the GRF specification status link, then consider the work complete when station usage is documented and the collaborative draft is ready for the later wiki conversion.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.