-
-
Notifications
You must be signed in to change notification settings - Fork 40.7k
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
Overhaul the QMK documentation #8252
Conversation
I have one request. Some links in documents refer directly to sections of other documents. newbs_git_resynchronize_a_branch.md: Now your GitHub fork, your local files, and QMK's repository are all the same.
From here you can make further needed changes
([use a branch!](newbs_git_using_your_master_branch.md#making-changes)) and post them as normal. newbs_git_using_your_master_branch.md: ## Making Changes
To make changes, create a new branch by entering: Translators into other languages do not want to change the link information, so they need to do the following: ja/newbs_git_resynchronize_a_branch.md: これで、あなたの GitHub フォーク、あなたのローカルファイル、および QMK のリポジトリはすべて同じになりました。
ここから、[ブランチを使って](ja/newbs_git_using_your_master_branch.md#making-changes)さらに必要な変更を加え、通常どおりそれらを投稿できます。 ja/newbs_git_using_your_master_branch.md: ## 変更を行なう :id=making-changes
変更するには、以下を入力して新しいブランチを作成します: So, if the original (English) document looks like this, it will help all translators. newbs_git_using_your_master_branch.md: ## Making Changes :id=making-changes
To make changes, create a new branch by entering: It is useful to have |
If you overhaul the document, there are suggestions. Currently, in Japanese translated documents, the commit hash at the time of translation is included in the document (see da1a527#diff-b3e744151f02a5bd4939286ba46df368R4), and the change history can be obtained by executing command such as |
@mtei Good idea, I've just pushed a commit with that change. @shelaf This seems like a good idea. We can make this change but it should probably be done separately from this PR. I don't think we will be able to use Transifex as that that tool is rather expensive, but we are supportive of setting up an open source or free alternative. The best way to push that forward is to open an issue and suggest some possible tools we can implement. Hopefully community discussion can provide a clear direction from there. |
OK. I don't do much research on these support tools, so I need to make sure we can do what we want. |
Also clean up some trailing whitespace.
Update the text sample for when the compile task completes.
- minor typo on intro paragraph (the -> them) - remove note about :check-size target (`make` task now does this automatically) - heading level for Caterina commands section - typo regarding Halfkay (come -> comes)
Showing a current version of QMK Toolbox
Apparently I can't approve my own PR, but the changes that @noroadsleft has made LGTM. |
It prevents the Table of Contents from parsing that heading.
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.
I think I'm satisfied for this stage of updates.
@skullydazed What was you reasoning behind d1c1808? The commit is titled “wip” and delete Can this commit be reverted or where should the unique information that was present in |
@bricewge I removed that page because in general that information is contained in https://docs.qmk.fm/#/newbs_getting_started and part of my goal here was to reduce duplication. At the time I didn't realize that was the only place the Nix commands were documented. Reviewing that now it looks like that doesn't follow the correct pattern anyway. We handle all package installation through |
Looks like this PR removed the documentation for |
Lots of improvements to the QMK documentation:
prefers-color-scheme: dark
Screenshot of new theme, homepage, and sidebar.
Types of Changes
Checklist