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

Overhaul the QMK documentation #8252

Merged
merged 41 commits into from
Mar 6, 2020
Merged

Overhaul the QMK documentation #8252

merged 41 commits into from
Mar 6, 2020

Conversation

skullydazed
Copy link
Member

@skullydazed skullydazed commented Feb 27, 2020

Lots of improvements to the QMK documentation:

  • Reorganize the sidebar
  • New theme
  • Dark mode support using prefers-color-scheme: dark
  • Table of Contents
  • Rename the Newbs Guide to Tutorial
  • Promote the use of the CLI in the Tutorial
  • Overhaul the handwire guide
  • Bring in the API documentation
  • Add Copy button to code boxes
  • Update the configurator video

Screenshot of new theme, homepage, and sidebar.

Types of Changes

  • Enhancement/optimization
  • Documentation

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@mtei
Copy link
Contributor

mtei commented Feb 27, 2020

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 :'id=... for sections that are referenced elsewhere (Not all sections).

@shelaf
Copy link
Contributor

shelaf commented Feb 27, 2020

If you overhaul the document, there are suggestions.
Would you please move all English documents to under the en folder?
The main reason is that it is difficult to check if the translated document is older than the original. This check can be simplified by introducing translation support tools such as Transifex and linking to Github, but these support tools assume that the original text is in a specific language code folder.

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 grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh | grep '^--- a/'. However, such a maintenance method is very difficult.
And then, I would also be very happy if QMK could prepare a translation support tool officially :)

@skullydazed
Copy link
Member Author

@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.

@shelaf
Copy link
Contributor

shelaf commented Feb 28, 2020

OK. I don't do much research on these support tools, so I need to make sure we can do what we want.
In addition, the comment system of these tools is often poor than Github, so I think it is necessary to evaluate usability, too.
I don't have time to do this research right now, so it will be a while away.

@drashna drashna requested a review from a team March 1, 2020 00:41
@skullydazed
Copy link
Member Author

Apparently I can't approve my own PR, but the changes that @noroadsleft has made LGTM.

Copy link
Member

@noroadsleft noroadsleft left a 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 skullydazed merged commit 76189d9 into master Mar 6, 2020
@skullydazed skullydazed deleted the docs_reorg branch March 6, 2020 00:00
@bricewge
Copy link

@skullydazed What was you reasoning behind d1c1808? The commit is titled “wip” and delete docs/getting_started_build_tools.md which contains documentation about how to build QMK with Nix which, information which isn't present anywhere else in the repo. Further more there are still links, dead links, to this file in the current master.

Can this commit be reverted or where should the unique information that was present in docs/getting_started_build_tools.md should go now?

@bricewge bricewge mentioned this pull request Apr 18, 2020
@skullydazed
Copy link
Member Author

@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 util/qmk_install.sh (and associated OS specific scripts), and it appears that no one has done that work for Nix yet.

@sigprof
Copy link
Contributor

sigprof commented May 2, 2020

Looks like this PR removed the documentation for PERMISSIVE_HOLD_PER_KEY (added in #7994).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants