libgdx / libgdx/libgdx.github.io
Migrate other wikis
Open
Nobody has claimed this yet.
PRs welcome
- Dominant language
- HTML
- Stars
- 74
- Forks
- 313
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 3
Description
The wikis of the other libGDX repos should be migrated as well:
- gdx-ai
- ashley
- gdx-controllers (?)
-
fbx-conv(probably not worth it) - gdx-pay (?)
Steps involved (see #65)
The old wiki markdown files were ported to Jekyll with the help of this code. For smaller wikis, doing those steps manually or with a custom script might be easier.
- The main step involved was fixing the wiki-style links (
[[streaming-music]]->[streaming-music](wiki/audio/streaming-music.md)) and, in the course of this, organising the pages in subdirectories. - Similarly, the paths of assets located in the old wiki repo were changed to refer to their new location in
/assets/wiki/. - In addition, every wiki page now needs a frontmatter specifying a page title:
--- title: Modules overview ---
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the migration steps in #65 and the Spaio/libgdx-wiki-index code linked in the issue. Migrate the selected repository wikis, fixing wiki-style links and asset paths and adding page-title frontmatter; completion means the selected checklist entries have working Jekyll pages in their new locations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll, markdown
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100