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

feat: Prepare mdBook workflow for documentation #1441

Merged
merged 93 commits into from
Aug 21, 2024

Conversation

Zeglius
Copy link
Contributor

@Zeglius Zeglius commented Jul 31, 2024

Add tooling (scripts, Github actions) in order to transcribe Discourse documentation to one using mdBook in efforts of improving accessibility when contributing to documentation.

Note: now with commit d42a29c, transcription is automated, staying in sync unidirectionally with discourse.

@nicknamenamenick
Copy link
Contributor

nicknamenamenick commented Jul 31, 2024

This is a better method to go about this, and I'd love for this to open in the .desktop shortcut that we currently have. Some of this documentation is outdated, has errors compared to how it is on Discourse, and I may remove some of the Handheld Wiki since that's ever-changing and probably best viewed before installing Bazzite.

Copy link
Contributor Author

@Zeglius Zeglius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a better method to go about this, and I'd love for this to open in the .desktop shortcut that we currently have. Some of this documentation is outdated, has errors compared to how it is on Discourse, and I may remove some of the Handheld Wiki since that's ever-changing and probably best viewed before installing Bazzite.

This gonna take longer that I expected, so I would rather suggest to not remove anything, rather add a warning that Discourse hosted docs might be deprecated.

That is, only after we get a somewhat complete transcription to mdBooks

@nicknamenamenick
Copy link
Contributor

nicknamenamenick commented Jul 31, 2024

I'd love to have a ujust rtfm eventually too! Getting ahead of myself though, I won't remove anything from Discourse nor will I change the current offline doc files (but please note that several are outdated by now and they're most up to date on Discourse). I will try not to touch the Discourse documentation for a while from this point forward, and if you need any feedback, help, or want to change some of the documentation yourself, ping me on the Discord.

Using Discourse urls as fallback for missing content for now

docs: add missing image files
@KyleGospo KyleGospo enabled auto-merge August 19, 2024 17:16
auto-merge was automatically disabled August 19, 2024 17:59

Head branch was pushed to by a user without write access

@KyleGospo
Copy link
Member

@Zeglius Any luck on a local test? If this built I'm happy to merge

@Zeglius
Copy link
Contributor Author

Zeglius commented Aug 21, 2024

@Zeglius Any luck on a local test? If this built I'm happy to merge

@KyleGospo all of my local builds (in my repo) worked so far so should be ready to go.

@KyleGospo KyleGospo merged commit 181497b into ublue-os:main Aug 21, 2024
2 of 4 checks passed
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 size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants