Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Choose which of doc/README.* we want to keep #485

Closed
lmoureaux opened this issue Jun 23, 2021 · 9 comments · Fixed by #685
Closed

Choose which of doc/README.* we want to keep #485

lmoureaux opened this issue Jun 23, 2021 · 9 comments · Fixed by #685
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lmoureaux
Copy link
Contributor

Maybe not all of them are worth translating to Sphinx.

@lmoureaux lmoureaux added the documentation Improvements or additions to documentation label Jun 23, 2021
@lmoureaux
Copy link
Contributor Author

Quick look:

  • BUGS: Needs almost a complete rewrite
  • README: Small parts that can be salvaged, the rest can be thrown away
  • CodingStyle: Irrelevant, delete
  • HACKING: Mostly for coders, but some parts may be relevant for tilesets
  • HOWTOPLAY: Play guide, last updated 2016... relevant
  • README.achievements: Relevant, for ruleset editors
  • README.actions: Relevant, for ruleset editors
  • README.agents: A grand plan that never realized. Relevant for coders (CMA)
  • README.AI: Internal docs, no idea if still relevant
  • README.AI_modules: Not supported
  • README.attributes: Relevant, internal (used by CMA)
  • README.delta: Relevant, internal (network protocol)
  • README.effects: Relevant, for ruleset editors
  • README.fcdb: Only the database.lua part is still relevant, for sysadmins
  • README.governor: Relevant, for players
  • README.graphics: Relevant, for tileset artists. Reportedly incomplete and insufficient.
  • README.modplack_installer: Relevant for players, up-to-date
  • README.msys2: Relevant, devs on Windows
  • README.nations: Probably relevant. We also have a wiki page about this
  • README.packaging: I don't know
  • README.rulesets: Relevant, ruleset authors
  • README.scenarios: Relevant, devs and very skilled scenario makers
  • README.scorelog: Relevant, devs
  • README.sound: Could be reused as an introduction for sound spec docs
  • REAMDE.tilesets: Relevant, for tileset artists. Reportedly incomplete and insufficient.

In addition, there are (many outdated) translations of some of these and the man pages.

@jwrober
Copy link
Collaborator

jwrober commented Aug 4, 2021

PR #579 took care of HOWTOPLAY, FAQ, README.governor, and REAMDE.modpack_installer.

@jwrober jwrober self-assigned this Sep 12, 2021
@jwrober
Copy link
Collaborator

jwrober commented Sep 30, 2021

PR #675 took care of BUGS, CodingStyle, andh HACKING.

@jwrober
Copy link
Collaborator

jwrober commented Oct 1, 2021

PR #679 took care of README.achievements and README.actions

@jwrober
Copy link
Collaborator

jwrober commented Oct 2, 2021

PR #681 took care of README.fcdb and README.msys2

@jwrober
Copy link
Collaborator

jwrober commented Oct 2, 2021

@lmoureaux - mind have another look at the README.ai* files? I don't think either are useful any longer and think we can delete them.

@lmoureaux
Copy link
Contributor Author

After the first section or two, README.AI has info about how the AI works, I'd keep it as code documentation (maybe convert to a md file for Doxygen to parse).

README.AI_modules can be trashed.

@jwrober
Copy link
Collaborator

jwrober commented Oct 7, 2021

PR #682 took care of README.graphics

@jwrober
Copy link
Collaborator

jwrober commented Oct 13, 2021

PR #685 took care of TODO, README.AI, README.AI_Modules, README.sound, README.rulesets, README.nations, README.packaging, README.scorelog, and README.scenarios. This should close the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants