Pat Connors
9d349d9685
chore(docs): Updating Guide and Waydroid in docs home ( #1607 )
...
* chore(docs): Add update aliases
* chore(docs): Add gaming guide aliases
* chore(docs): still need emojis and text
* chore(docs): maybe i guess
* chore(docs): Waydroid edit
* chore(docs): Fix formatting
* chore(docs): No shortcut to installation guide for deck
READ EVERYTHING NOOBS
* chore(docs): Make Waydroid stand out
2024-09-10 15:27:14 +00:00
Pat Connors
e513b20b0e
chore(docs): Distrobox Edits ( #1644 )
...
* chore(docs): Distrobox Edits
Small formatting
* chore(docs): snarky note
2024-09-10 15:26:44 +00:00
Pat Connors
8df95d4ebe
chore(docs): Handheld Wiki Updates ( #1645 )
...
* chore(docs): ally
* chore(docs): ayaneo
* chore(docs): period1
* chore(docs): period2
* chore(docs): ayn
* chore(docs): no <hr>
* chore(docs): GPD
* chore(docs): yes <hr> 1
* chore(docs): Yes <hr> 2
* chore(docs): yes <hr> 3
* chore(docs): Legion Go
* chore(docs): desc1
* chore(docs): desc2
* chore(docs): desc3
* chore(docs): desc4
* chore(docs): desc5
2024-09-10 15:26:31 +00:00
Pat Connors
cf546955fd
chore(docs): New announcement for documentation ( #1646 )
...
I am in the process of editing the rest of the documentation to have it on par with the final changes I made to the Discourse version before the Github transcription happens. That PR will happen either later today or tomorrow, but by the end of the week the Discourse documentation will no longer be updated ever again and will remain the old, unlisted documentation.
The docs (or user guides as I view them) now live here and can be modified in any way that both consistent maintainers/contributors and new users who want to edit the documentation (and gets approved) sees fit.
2024-09-10 15:26:17 +00:00
Pat Connors
f35d241b71
chore(docs): Documentation Documentation Fix? ( #1648 )
...
@Zeglius I initalliy edited the README for the docs because of the "cant" for grammatical purposes, but I also removed a bunch since we're past the transcribing part. Anything I should bring back or add?
2024-09-10 15:25:53 +00:00
Aarron Lee
a427ea5989
chore(docs): Update outdated Decky info in docs ( #1651 )
...
PauseGames works on Bazzite
2024-09-10 15:25:41 +00:00
Zeglius
2d5f6e352d
docs: Replace discourse URLs with local ones ( #1624 )
...
* docs: Replace discourse urls with local ones
* chore(docs): Comment bazzite.css
* chore(docs): Slightly increase toc section name
* docs: Add missing url replacements
* docs: Move unstable docs warning to announcement bar
* docs: Replace handheld wiki urls
* chore(docs): Add view and edit source buttons
* docs: Replace software management urls
* docs: Replace hardcoded docs URLs
2024-09-07 14:00:02 +00:00
HikariKnight
d94c431aba
Merge pull request #1613 from nicknamenamenick/patch-24
...
chore(docs): Handheld Wiki can be edited properly
2024-09-05 23:59:48 +02:00
Zeglius
2d06fd4acb
chore(docs): Replace external images with local ones ( #1616 )
...
* chore(docs): Add image downloader script
* chore(docs): Move favicons to static dir
* chore(docs): Replace external images with local ones
* chore(docs): Remove unnecesary imports from fetch_discourse_images.py
* docs: Rename 'Updates_Rollbacks_&_Rebasing' to 'Updates_Rollbacks_and_Rebasing'
* chore(docs): Add rename_image_names.py
* chore(docs): Rename images
* chore(docs): Fix rename_image_names.py not being able to catch all images
* chore(docs): Rename more images
* chore(docs): Rename even more images
* chore(docs): Rename even more images again
* chore(docs): Remove leftover duplicate images
2024-09-05 21:59:02 +00:00
Pat Connors
e847e3ec27
chore(docs): Fix broken links in auto-mount guide ( #1621 )
2024-09-05 21:57:42 +00:00
Pat Connors
fba4f5dc1a
chore(docs): Add a shortcut for auto-mounting drives ( #1620 )
...
Probably a big mistake, but it's still somewhat hidden deep within one of the gaming guides (and the search). Sick of seeing the question.
2024-09-05 21:57:13 +00:00
Pat Connors
eda557edf0
chore(docs): Last change to warning ( #1614 )
...
* chore(docs): Last change to warning
Keeping the warning for at least 2-3 more days.
* chore(docs): "new"
2024-09-05 18:48:23 +00:00
Pat Connors
b5b9c5ff2a
chore(docs): Fix issues with ujust documentation ( #1612 )
2024-09-05 12:39:36 +00:00
Pat Connors
b48cdb30c8
chore(docs): Handheld Wiki can be edited properly
...
Now that we're on Github... again.
2024-09-04 13:20:06 -04:00
Zeglius
73ebc95f8b
docs: Transcribe docs to github ( #1602 )
...
* docs: Add new transcribe script
* chore(docs): Add usage help to transcribe.py
* chore(docs): Add file argument requirement to transcribe.py
* chore(docs): Move transcribe.py usage example to bottom
* chore(docs): Replace transcribe.py stdout separator with tab
* chore(docs): Major optimizations for fetch_discourse_md.py
Now is 2x faster
* chore(docs): Add docs build benchmark script
* chore(docs): Separate url mappings in its own yaml file
* chore(docs): Remove outdated fetch_discourse_md.py docs
* chore(docs): Apply default empty url_mapping if url_overrides.yml is not pressent
* chore(docs): Add log message to cmdrun.py when url_overrides.yml is not found
* chore(docs): Exclude leftover heading from raw markdown
* docs: Transcribe docs to github
* docs: Fix distrobox package managers table
* docs: Format distrobox article
Decrease headings hierarchy across all the article
* docs: Remove duplicate automounting guides
2024-09-03 19:55:40 +00:00
Pat Connors
484ac42486
chore(docs): wtf is a mkdocs!???!?!? ( #1606 )
...
last one fr fr
2024-09-03 19:49:23 +00:00
Pat Connors
74de911fd8
chore(docs): Reset forgotten password name fix ( #1605 )
...
* chore(docs): Change name of reset user password
Too confusing of a name.
* chore(docs): Add "handhelds" to the list
this time for real is the last PR for at least the next 30 minutes from me.
2024-09-03 18:59:23 +00:00
Pat Connors
59f7ca5295
chore(docs): Hotfix ( #1604 )
...
* chore(docs): Hotfix
I want to work on an Update section next, but not today. giving the acks a break. thanks.
* chore(docs): Remove update alias for now
2024-09-03 18:01:46 +00:00
Pat Connors
e69170ec75
chore(docs): Add auto-mount documentation (hidden) ( #1581 )
...
* chore(docs): Add KDE Auto-Mount Guide (hidden)
* chore(docs): Add GNOME auto-mount guide (hidden)
2024-09-03 17:55:38 +00:00
Pat Connors
c1c712bf34
chore(docs): Minor improvements (again) ( #1603 )
...
This time merge this before conflicts happen. Please and thank you @noelmiller @HikariKnight @KyleGospo
2024-09-03 17:46:05 +00:00
Zeglius
95094c381e
chore(docs): fix cmdrun breaking image url replacement ( #1600 )
...
* chore(docs): fix cmdrun breaking image url replacement
* ci(docs): Trigger deploy_docs with any change in docs dir
2024-09-03 15:53:20 +00:00
Zeglius
6d05181146
docs: Add missing automounting guides ( #1594 )
...
* chore(docs): Fix cmdrun hook substituting urls with partial matches
* docs: Add missing automounting articles
2024-09-02 18:30:08 +00:00
Kyle Gospodnetich
2470469be4
chore(docs): Enable ligatures on code
2024-08-31 19:42:43 -07:00
Kyle Gospodnetich
1a09746f6d
chore(docs): Use Fira Code for code blocks, matching bazzite.gg
2024-08-31 19:40:46 -07:00
Zeglius
7477b8c3ea
chore(docs): Minor cosmetic improvements and fixes ( #1590 )
...
* chore(docs): Remove css hiding hr in cards
* chore(docs): Isolate centered headers inside page content
* chore(docs): Rounded search bar and accent colors
* chore(docs): Prevent image "squashing" in screens with reduced width
2024-08-31 19:34:34 -07:00
Kyle Gospodnetich
accc7540bb
chore(docs): Center headers on mobile, add background to blockquotes
2024-08-31 14:33:59 -07:00
Kyle Gospodnetich
53275f3f4e
chore(docs): Fix dark colored cards
2024-08-31 14:24:48 -07:00
Kyle Gospodnetich
61f2bc405f
chore(docs): More CSS tweaks to match bazzite.gg
2024-08-31 14:20:27 -07:00
Zeglius
cdf8c8d8ed
docs: Replace 'Table of Contents' page with a quick start one ( #1588 )
2024-08-31 20:27:43 +00:00
Zeglius
b7ded48ce1
fix(docs): Use a working match substitution in md_image_sizing hook ( #1584 )
...
* fix(docs): Use a working match substitution in md_image_sizing hook
This fixes odd page segment duplicating inside themselves
* ci(docs): Avoid triggering deploy_docs on PR
2024-08-31 15:47:54 +00:00
Pat Connors
a515c743ee
chore(docs): Fix note at the top ( #1575 )
...
Grammar
2024-08-30 17:04:48 +00:00
Zeglius
8739c239b0
fix(docs): Several fixes for mkdocs ( #1571 )
...
* fix(docs): Use a more consistent image url replacing in fetch_discourse_md
* fix(docs): Prevent youtube video from embeding in links
* chore(docs): Move embed_youtube hook to on_page_content step
* docs: Add 'md_image_sizing' hook
This will match image sizes with discourse ones
2024-08-30 15:30:42 +00:00
Zeglius
f526002bd2
docs: Hide 'Auto-Mounting Secondary Drives' article ( #1576 )
2024-08-29 19:51:49 +00:00
Kyle Gospodnetich
942908c23b
chore(docs): Mobile fixes
2024-08-29 07:18:19 -07:00
Kyle Gospodnetich
ee51662b9e
Revert "chore(docs): Custom title font"
...
This reverts commit 646d3f380f0224e6a8e8e7b2417bda89204199ad.
2024-08-28 18:00:51 -07:00
Kyle Gospodnetich
646d3f380f
chore(docs): Custom title font
2024-08-28 17:49:23 -07:00
Kyle Gospodnetich
d24481ee66
chore(docs): Add bottom padding to pill
2024-08-28 17:45:19 -07:00
Kyle Gospodnetich
180cbd81b4
chore(docs): Set background colors
2024-08-28 17:42:34 -07:00
Kyle Gospodnetich
a81d717b2e
chore: Adjust deep purple definition for docs
2024-08-28 17:36:52 -07:00
Kyle Gospodnetich
2a6f2c8782
chore: Use deep purple color scheme
2024-08-28 17:35:11 -07:00
Kyle Gospodnetich
def05a92e7
chore(docs): Add basic CSS theme
2024-08-28 17:30:33 -07:00
Zeglius
0e18978fe1
feat(docs): Replace mdbook with mkdocs workflow ( #1548 )
...
* feat: add mdbook docs
* chore: add several articles to docs
* docs: add documentation at surface level
Using Discourse urls as fallback for missing content for now
docs: add missing image files
* docs: Add missing chapter emojis
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
* docs: Realocate 'Gaming' section under 'General'
* docs: Add 'Introduction' section
This section contains a table of contents of the documentation
* docs: Add unstable documentation warning
* docs: Add missing github url
docs: add missing symlink to resources
* docs: Add discourse scrapper utility
* docs: minor discourse scrapper docs changes
* docs: Add youtube embeding preprocessor
* minor reformat for youtube-embed
* docs: Add mdbook preprocessor template
* docs: add format-author preprocessor
* docs: add git lib to mdbook toolset
* docs: Always fetch the highest quality image by fetch_discourse_md
* docs: fix youtube-embed ignoring new line requirement
* docs: Add documentation transcription guide
* docs: Missing url in transcription guide
* docs: Remove YAML header from doc guide
* docs: Minor tweaks to transcription guide
* docs: Add utilities preprocessor module
docs: Move debug preprocessor util to utils
* docs: tweak debug function
* docs: Add 'replace-urls' preprocessor
* chore: Move mappings parameter in replace-urls preprocessor
* docs: add ignore field to replace-urls
* docs: add Mdbook python types
* docs: Add ignore field to replace-urls
Now we can exclude files from being processed with blob patterns
* chore(ci): add deploy_docs
* chore(ci): Add dynamic edit url template to deploy_docs
* chore(ci): Add html.site-url to deploy_docs
* chore(readme): Use relative paths for repo_content
* chore(ci): Add README to included paths for deploy_docs
* chore(ci): Disable deploy_docs
* chore(ci): Use main in deploy_docs.on.push.branches
* docs: Rephrase unstable docs warning
* chore(ci): Exclude docs from triggering build workflow
* chore(ci): Enable deploy_docs
* fix(docs): Remove unnecessary imports in preprocessors
* docs: Move unstable docs warning to index.hbs
* docs: Add page metadata inclusion with fetch_discourse_md.py
* docs: Move fetch_discourse_md.py to docs/utils
* docs: Add 'fetched_at' metadata field in fetch_discourse_md.py
* docs: Update fetch_discourse_md.py to format metadata in json
* Revert "chore(readme): Use relative paths for repo_content"
This reverts commit 6a781c659607e0c83c19248241684c5785c7e93b.
* docs: Replace include with an url to repo README
* ci(docs): Add multilanguage doc build support
* docs: add Justfile utility
* docs: update Justfile utility
* ci(docs): Add stricter workflow trigger to deploy_docs
* docs: add 'preview_translation' to Justfile
* docs: add documentation translation guide
* ci(docs): Add mdbook cache
* ci(docs): Add i18n-report
* ci(docs): tweak deploy_docs workflow triggers
* ci(docs): remove unnecessary slash at build.yml
* ci(docs): remove unnecessary slash at deploy_docs.yml
* ci(docs): add docs/book.toml to deploy_docs trigger
* ci(docs): Add schedule trigger
* ci(docs): add github-pages cleaning
* ci(docs): Exclude docs from generate_changelog
* docs: Add dependencies installation script
* ci(docs): Add mdbook pdf build
* docs: Tweak Justfile to support pdf generation
* Revert "docs: Always fetch the highest quality image by fetch_discourse_md"
This reverts commit 74130ee1fe9264dc7a4c4c49fb416ef3dc12e322.
* ci(docs): Exclude deploy_docs.yml from cache-mdbook keys
* docs: Add 'mdbook_build' to Justfile
* docs: Add 'mdbook_serve' to Justfile
* docs: Add debug flag to fetch_discourse_md
* docs: Automate discourse documentation scrapping
* docs: Add flock to fetch_discourse_md
* docs: Add translation file generation with Justfile
* docs: Prefix url replacements with site-url in replace-urls.py preprocessor
* docs: Add installation guides
docs: Replace print button
* Revert "docs: Prefix url replacements with site-url in replace-urls.py preprocessor"
This reverts commit a685de4dce54debc900607d743069b79202a26ac.
* Reapply "docs: Prefix url replacements with site-url in replace-urls.py preprocessor"
This reverts commit 777d8055eac7543001200834939c960fb490e666.
* docs: fix replace-urls.py
* docs: fix fetch_discourse_md.py hitting discourse ip_10_secs_limit
* ci(docs): Remove duplicate '/' in build translation step
* ci(docs): Update actions/cache
* ci(docs): Reduce deploy_docs schedule timespan between triggers
* docs: update install-deps.sh
* docs: Update Advanced docs
* docs: Add favicon
* docs: Reword unstable documentation warning
* docs: Change default theme to 'navy'
* ci(docs): Move permisions to job scope
* docs: refactor fetch_discourse_md.py
Now it will export the function 'fetch', which other python scripts can
use
* docs: Add mkdocs skeleton
* docs: Add cmdrun hook
* ci(docs): Migrade deploy_docs to use mkdocs
* chore: remove mdbook leftover files
* docs: add support for markdown emojies
* docs: add support for i18n translations to mkdocs
* docs: add resource prefetching
* docs: enable navigation indexes in toc
* docs: add unstable documentation warning
* docs: normalize toc
docs: Add markdown magiclinks
* docs: remove unnecesary extensions
* ci(docs): Separate docs build into its own action
* ci(docs): fix build docs action
* ci(docs): Add default parameters to build_mkdocs action
* ci(docs): Clean up leftover mdbook files
* docs: remove leftover mkdocs-print-site-plugin
* chore: add mkdocs offline documentation
* docs: fix list indentation
* ci(docs): Add github links to mkdocs
* ci(docs): Add github authors to mkdocs
* docs: Update documentation guide and scripts to mkdocs
* docs: Add cache capabilities to cmdrun hook
* docs: Enable instant loading
docs: Enable toc in sidebar
* docs: Update summary and add more posts
* docs: Add mkdocs-material social plugin
* docs: Disable instant loading
* docs: Fix section url
* docs: Fix fetch_discourse not fetching images properly
* docs: Disable warning for using absolute links
* docs: Add url replacement hook
* docs: Restore 'General' section
* docs: Remove aditional languages for now
* docs: Add missing page titles
* docs: move and rename index.md to docs/src/Handheld_and_HTPC_edition/Steam_Gaming_Mode.md
* docs: remove leftover Bazzite_resources.md
* docs: Add time fallback to git-revision-date
* docs: Add navigation tabs
* docs: Clear cmdrun cache with Justfile
* docs: Add missing dual-boot guide url
* docs: Change to a shorter section name for handheld and HTPC
* docs: Add embed_youtube hook
* docs: Remove leftover resources entry in index
docs: Fix outdated 'Steam Gaming Overview' link in index
* docs: Limit vertical image size
* docs: add more url replacements
* docs: Enable search features
2024-08-28 15:48:19 -07:00
Pat Connors
230dd18517
chore(docs): i lied ( #1561 )
...
last PR for docs today pinky promise!!! also i'll look into the RGB rainbow goofy stuff later.
RGB was a mistake.
2024-08-27 12:46:33 -07:00
Pat Connors
5dcbf958cd
chore(docs): Add 'Fork An Image' Documentation ( #1560 )
...
This is the last PR for the docs today I promise!!!
2024-08-27 18:36:55 +00:00
Pat Connors
6914233159
chore(docs): Delete Physical Keyboard Layout ( #1556 )
...
* chore(docs): Delete Physical Keyboard Layout
* chore(docs): Remove reference file
2024-08-27 16:14:09 +00:00
Pat Connors
cb3fe27abf
chore(docs): Shorten Steam Gaming Mode docs header ( #1557 )
2024-08-27 16:13:48 +00:00
Pat Connors
17e987ccc8
chore(docs): Fix broken Hardware Compat. Documentation ( #1558 )
2024-08-27 16:13:37 +00:00
Kyle Gospodnetich
c8650cf10d
chore(docs): Fix reference to Bazzite_resources.md
2024-08-26 19:32:24 -07:00
Pat Connors
9dfd55f495
chore(docs): Delete Bazzite Resources ( #1551 )
...
Sorry for reporting this as a bug, but since we're going the route without emojis (which I am now going to be removing in the docs soon), I think it's best to keep this exclusive to the forum.
2024-08-26 18:44:29 -07:00
Zeglius
3a28c6e905
docs: Add new doc pages ( #1545 )
...
* docs: Add new doc pages
docs: Add new updates rollbacks and rebase section
docs: Add Bazzite Resources post
docs: Add reporting bugs post
docs: Add secure boot post
docs: Add installation troubleshoot guide post
docs: Add dual boot setup guide post
docs: Add common gaming issues post
docs: Add managing and modding games post
docs: Add hardware compatibility for gaming post
* docs: Remove emojies from page names
* docs: Simplify image fetching logic
This fixes #1547 missing images.
Credit to @wolfyreload for the tip about 'uploads/short-url'
2024-08-26 19:59:19 +00:00
