Overhaul docs #16
Merged
Overhaul docs #16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 8 commits
August 8, 2024 19:04
- so local testing is possible - via replacing all occurances of "https://pygame-web.github.io/wiki" with "/wiki" - two paths, https://pygame-web.github.io/archives/... and https://pygame-web.github.io/showroom/... are links to places, but do not show up in the repo file path. not sure what's going on here, so I just kept these as absolute paths
…/pygbag/ -> /wiki/ - before, the site's main page refers to a wiki while also exposing some documentation on that main page. this was very confusing to me: was I supposed to use the wiki for information or the main page? - this way, the main page is clean is it is clear it exists to be a CDN root, while pointing to a definitive source of information, the wiki page.
- I feel like this makes the directory structure feel more understandable; pages and itch publishing are now under "publishing" instead of under "pygbag"
- instead of having two separate tutorials for itchio publishing, link one to a canonical tutorial
- very little material should have been cut, and almost all cut material was redundant/duplicate
- somehow, a few /showroom links got converted.
|
Oh wait, I forgot to add this back in: ## Adding modules
- [List of available wheels](/wiki/pkg/)
- [requesting modules](https://github.com/pygame-web/pkg-porting-wasm/issues)I've already closed all my windows and I'm tired so someone or I can just do that later. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it looks like live at https://wade-cheng.is-a.dev/pygame-web.github.io/. This preview is on the
view-sitebranch instead of this branch because my project gh pages site has thedomain/pygame-web.github.io/link instead ofdomain/, which messes up relative links to the root.Here's a trimmed down
git logthat shows my thought process behind the commits.fix broken links
overhaul wiki structure
consolidate publishing info
move github pages and itch publishing pages to their own folder
fix broken link /wiki/pygame-script -> /wiki/pygbag-script
move bulk of site README.md to /wiki/README.md; point wiki from /wiki/pygbag/ -> /wiki/
fusing to me: was I supposed to use the wiki for information or the main page?
replace absolute paths with relative paths to this website
update gitignore for local testing with jekyll