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

docs: Update intro page #2767

Merged
merged 6 commits into from
Jan 23, 2025
Merged

Conversation

caksoylar
Copy link
Contributor

Attempt to update the intro page to docs, converting the comparison table to a feature/capabilities list. Then, split it into categories and add new items for in-progress work.

The last two are split into different commits, if you want to see intermediate states (but I'll squash them all into one before merging).

@caksoylar caksoylar added the documentation Improvements or additions to documentation label Jan 14, 2025
@caksoylar caksoylar requested a review from a team as a code owner January 14, 2025 06:33
@caksoylar
Copy link
Contributor Author

Question: Is it better to use subheadings rather than table header rows for category names?

Copy link
Contributor

@Nick-Munnich Nick-Munnich left a comment

Choose a reason for hiding this comment

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

Agree that this has been overdue. Aside from my minor comments, my biggest complaint is how the tables appear on the page. If it's possible to center the legend table and move the keymap and connectivity tables to be on the right of the hardware table when there is the space for it, that'd improve the situation massively for me. Other alignment stuff too.

@caksoylar
Copy link
Contributor Author

caksoylar commented Jan 14, 2025

Aside from my minor comments, my biggest complaint is how the tables appear on the page.

I agree with this, it doesn't look good. I don't know if we can easily put tables side-by-side. My initial thought was making the tables full width like https://zmk.dev/docs/keymaps/list-of-keycodes, which seems to require using a custom element rather than a markdown table, to add a bit of CSS. Or we can go back to a single table.

@caksoylar
Copy link
Contributor Author

I gave the two column suggestion @Nick-Munnich had a shot, using the implementation from https://docusaurus.community/knowledge/component-library/new/Columns/. It still isn't perfect but seems better, I am open to other ideas.

Copy link
Contributor

@Nick-Munnich Nick-Munnich 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 it looks good, I'm happy.

Copy link
Contributor

@petejohanson petejohanson left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

@caksoylar caksoylar merged commit 4f72e7c into zmkfirmware:main Jan 23, 2025
7 checks passed
@caksoylar caksoylar deleted the docs/update-intro branch January 23, 2025 00:58
tjmitchem pushed a commit to tjmitchem/zmk that referenced this pull request Feb 12, 2025
tjmitchem pushed a commit to tjmitchem/zmk that referenced this pull request Feb 13, 2025
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants