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

Move the static text in helpdata.txt to Sphinx #1264

Open
jwrober opened this issue Aug 13, 2022 · 5 comments
Open

Move the static text in helpdata.txt to Sphinx #1264

jwrober opened this issue Aug 13, 2022 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jwrober
Copy link
Collaborator

jwrober commented Aug 13, 2022

What should be documented? Is there something wrong in the documentation?
Right now we have a generalized, non-ruleset specific "how to play" type content in the helpdata.txt file. Intertwined in this static text is generated ruleset specific help for units, improvements, wonders, etc. This should be moved to Sphinx.

Do you have suggestions?
Update/replace the current "How to Play" RTD page with the static content from helpdata.txt. This will enable us to use the QtHelp builder of Sphinx to ship some or all of the docs with the package. This would allow cross links between documents.

@jwrober jwrober added the documentation Improvements or additions to documentation label Aug 13, 2022
@lmoureaux
Copy link
Contributor

The idea is be to eventually generate qhp files for the Help Framework, using Sphinx' built-in ability to do so. We'd then add a simple qhp viewer to the client and obtain full offline docs synchronized with the online version.

@jwrober
Copy link
Collaborator Author

jwrober commented Aug 19, 2022

Associated with #506

@jwrober
Copy link
Collaborator Author

jwrober commented Mar 28, 2023

@lmoureaux @daavko any ideas on how to integrate the static text in helpdata.txt into RTD? Do we want to wire it into existing folders or do a separate "help" folder? The title "strategy and tactics" is already how-to-play.rst, so could create more pages in Playing.

@lmoureaux
Copy link
Contributor

I'd guess reproduce the in-game help structure in the rtd?

@jwrober
Copy link
Collaborator Author

jwrober commented Mar 29, 2023

  • Overview is already Getting/about.rst
  • Strategy and Tactics is already Playing/how-to-play.rst
  • Terrain could be Playing/terrain.rst?
  • We need Add Helptext for resources in packaged rulesets #655 done so we show more about Terrain Resources in game help, or can create a page for it in RTD
  • Terrain Alterations could be added to Playing/terrain.rst?
  • All the Economy pages could be Playing/economy-overview.rst?
  • All the Cities pages could be Playing/city-management.rst or cities-overview.rst?
  • City Improvements could be Playing/city-improvement-overview.rst?
  • Wonders of the World could be Playing/great-wonders-overview.rst?
  • Units could be Playing/units-overview.rst?
  • Combat... There is Improve the documentation of combat mechanics #1858. Could be Playing/combat-overview.rst?
  • ZOC could be Playing/zone-of-control.rst?
  • Government could be Playing/governments-overview.rst?
  • Ignore policies...
  • Ignore effects, rely on pyciv for that.
  • Diplomacy could be Playing/diplomacy-overview.rst?
  • Technology could be Playing/technology-overview.rst?
  • Space Race could be Playing/spaceship-overview.rst?
  • Ignore Nations top level?
  • Might get rid of Connecting since we don't do the metaserver and proxy's are kinda old school. Then again we have Switch to a metaserver of our own #638
  • We have Auto-generate keyboard shortcuts in helpdata.txt #656 for Controls, which I think is a better option since it would reflect what the user has bound the key to.
  • For Citizen Governor we already have Playing/cma.rst
  • Chatline could be Playing/game-chat.rst?
  • We already talk about the worklist editor in the game manual.
  • Not sure what to do with Languages page.
  • Copying is the GPL licence page
  • About is mostly autogen, so not sure what to do there.

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

No branches or pull requests

2 participants