Skip to content

Add documentation to map-generator go code #2602

@Tidwell

Description

@Tidwell

Much of the documentation for how the map generator works is spread over Discord posts. Adding documentation to the map generator can ensure the reference material gets updated alongside the code. Of particular interest is any analysis of the script, ex: the color mapping, b&w usage, river and ocean info, nation strengths, etc.

Go offers godoc to generate documentation for go code.

Discord megathreads with "evergreen" documentation:

https://discord.com/channels/1284581928254701718/1350917721444847639
https://discord.com/channels/1359946986937258015/1361003022074904743/1361003022074904743

Suggest:

npm run docs:map-generator => cd map-generator && godoc

Metadata

Metadata

Assignees

Labels

MapsA new map, or adjustments to an existing map itself, its json, etc,will not stalePRs that will not be closed by the stale action

Type

Projects

Status

Triage

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions