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

Minimal doc changes for 3.0 #2325

Open
1 of 7 tasks
einarf opened this issue Jul 28, 2024 · 1 comment
Open
1 of 7 tasks

Minimal doc changes for 3.0 #2325

einarf opened this issue Jul 28, 2024 · 1 comment

Comments

@einarf
Copy link
Member

einarf commented Jul 28, 2024

Minimal tasks for 3.0 release. Some of these can be done incrementally

  • Do a pass on front page
  • Fill out the about section
  • Fill out the contributing section
  • Fill out the community section
  • Resolve differences between arcade book and the skill tree
  • Organize the api references. These needs to be put in categories one level down
  • Organize the manual

Still, moving things can create future issues when users move between doc versions. We should try to establish structures as soon as possible.

@pushfoo
Copy link
Member

pushfoo commented Oct 22, 2024

WIP notes

Community section

https://api.arcade.academy/en/development/about/intro.html#community-driven

  1. (@pushfoo) Rephprase this paragraph
  2. Put links first in the list as calls to action

https://api.arcade.academy/en/development/contributing/index.html#how-to-contribute

  1. Turn learning resource list into links

https://api.arcade.academy/en/development/contributing/index.html#how-to-contribute-without-coding

  1. Table the history links?

https://api.arcade.academy/en/development/community/community_locations.html#community-locations

  1. s/discord server/Discord server/g (it's a brand)

Q: Move "how to get help" into "Getting Started"?

https://api.arcade.academy/en/development/community/games/sample_games.html

  1. Fix example game page links (some are markdown instead of ReST )

Book + Skilltree Page

Resolve differences between arcade book and the skill tree

I started taking a look at this. My initial impression is that we need to split + rename this page as follows:

  1. Rename it to Introduction
  2. Move it up the TOC tree to be above Install
  3. Remove mentions of / references to the book here because it won't be 3.0 compatible for a long while
    • Add a .. note:: for educational users who need long-term support which links a page on 2.6.18 vs 3.0
    • Replace the [Learn Arcade book sound chapter](https://learn.arcade.academy/en/latest/chapters/20_sounds/sounds.html) link with the programming guide sound page
    • Fix the sound demos:
      • Add on-screen labels of some sort so it's not just squares
      • Add arrows ( can be text-based )
    • Fix inconsistent physics engine formatting
  4. Move the skill tree to a new Skill Tree page

The 2.6.18 vs 3.0 page can live on either site (3.0 or 2.6.X). Here's a rough concept for a plan:

  • I do some 2.6.18 polish on:
    • A "compatibility maintenance-only" page
    • Our own warnings for RTD
  • We ship 2.6.18 / etc
  • We update the doc for whichever versions need to point to it wherever

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

No branches or pull requests

2 participants