-
-
Notifications
You must be signed in to change notification settings - Fork 296
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
feat(docs): Replace mdbook with mkdocs workflow #1548
Merged
Merged
Conversation
This file contains 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
Using Discourse urls as fallback for missing content for now docs: add missing image files
docs: Add missing warning in Advanced docs in summary docs: add missing waydroid guide docs: rename files to avoid spaces docs: fix badly set docs build params docs: remove unnecesary placeholders
This section contains a table of contents of the documentation
docs: add missing symlink to resources
docs: Move debug preprocessor util to utils
Now we can exclude files from being processed with blob patterns
…Steam_Gaming_Mode.md
docs: Fix outdated 'Steam Gaming Overview' link in index
dosubot
bot
added
size:XXL
This PR changes 1000+ lines, ignoring generated files.
documentation
Improvements or additions to documentation
labels
Aug 28, 2024
KyleGospo
approved these changes
Aug 28, 2024
nicknamenamenick
approved these changes
Aug 28, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My approval doesn't affect whether or not this merges, but you got my seal of approval!!!!!
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
lgtm
This PR has been approved by a maintainer
size:XXL
This PR changes 1000+ lines, ignoring generated files.
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.
PR #1441 was meant to address:
Which was accomplished:
fetch_discourse_md.py
, a script that facilitates scrapping of Discourse pages, both automatically by mdbook and contributors who wish to transcribe to a markdown file in GitHub.It works, but would come to face several limitations imposed by mdbook:
Thus, MkDocs enters in scene:
article.es.md
instead of using Gettext.Not only that, but we replace the PDF generation with a locally hosted version of the documentation, which can be served with
python -m http.server
(documentation shortcut handles this).Far more friendly for Steam Game Mode users, as they can then access from Steam builtin web browser.