Commit Graph

47 Commits

Author SHA1 Message Date
Peter Johanson e2f7067808 docs: Add release version to the docs, with links and warning banner
Add versions to the sidebar of the documentation, and when viewing the
deployment on zmk.dev, which tracks `main`, add a banner warning about
possibly prefering the docs for a particular stable release.
2025-11-25 16:19:42 -07:00
Nicolas Munnich a6d09f8c00 docs: Added mastodon link in footer 2024-10-17 15:01:30 -06:00
Peter Johanson 0abc1eaf23 docs: Add ZMK Studio links.
* Add a toplevel ZMK Studio link in our header.
* Add link to the web and app releases to the feature page.
2024-10-14 09:42:06 -06:00
Nicolas Munnich 266227b580
refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
Cem Aksoylar b74cd39ab5 chore(blog): Use truncate markers 2024-09-01 00:15:23 -07:00
Peter Johanson feda96eb40 feat(studio): Initial RPC infrastructure and subsystems.
* UART and BLE/GATT transports for a protobuf encoded RPC
  request/response protocol.
* Custom framing protocol is used to frame a give message.
* Requests/responses are divided into major "subsystems" which
  handle requests and create response messages.
* Notification support, including mapping local events to RPC
  notifications by a given subsystem.
* Meta responses for "no response" and "unlock needed".
* Initial basic lock state support in a new core section, and allow specifying
  if a given RPC callback requires unlocked state or not.
* Add behavior subsystem with full metadata support and examples of
  using callback to serialize a repeated field without extra stack space needed.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-15 11:45:18 -06:00
Nicolas Munnich 308d6bce6e
feat(docs): Improve the toolchain setup page (#2272)
Split the toolchain setup into separate docker and native pages
and improve instructions to better refer to Zephyr docs in certain steps.
Also refactor to improve consistency and add virtualenv instructions.

---------

Co-authored-by: KemoNine <mcrosson@kemonine.info>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-06-01 21:51:08 -07:00
Joel Spadin a0465391be refactor: Improve keymap upgrader
Moved the keymap upgrader to a top-level page like the power profiler
to make it more discoverable. It upgrades more things than key codes
now, so putting it in the codes category doesn't make much sense.

Converted the upgrader code to TypeScript and split it up into smaller
files to make it easier to add new upgrade functions.

Added upgrade functions to remove/replace "label" properties and rename
matrix-transform.h to matrix_transform.h.
2024-01-25 18:03:37 -06:00
Cem Aksoylar dcfe07d9f6 refactor(docs): Use new admonition title syntax and disable mdx v1 compat 2024-01-20 22:28:41 -08:00
Cem Aksoylar 5b49bc10cd feat(blog): Show all posts on sidebar 2023-11-08 23:00:26 -08:00
Joel Spadin 4a339093ce docs: Add highlighting for devicetree and kconfig
Added syntax highlighting for devicetree and kconfig files.

The PrismJS project is not accepting contributions right now as they
work on a version 2 of the library, so the new language files are added
directly here.

Also enabled syntax highlighting for various languages that are used in
the docs but aren't enabled in Docusaurus by default.
2023-10-09 15:19:24 -07:00
Dom H c679b7e07d fix(docs): Standardize URLs with no trailing slash
Previously, a trailing slash would be appended to all URLs when accessed
directly, but not when accessed via menus and links.

This Docusaurus configuration option keeps the URLs consistent by never
appending a trailing slash.

https://docusaurus.io/docs/api/docusaurus-config#trailing-slash
2022-05-23 10:09:53 -04:00
Peter Johanson 6501e68c2d fix(docs): Remove breadcrumbs (for now)
* Remove breadcrumbs until they're useful
  with content for each level in our docs.
2022-04-06 06:01:39 -04:00
Peter Johanson c259c7b27a fix(docs): Updated proper API key. 2022-04-06 06:01:39 -04:00
Peter Johanson 60d367cbb9 refactor(docs): Bump to docusaurus 2.0.0-beta.18
* Fix up the config to use proper locations.
2022-04-06 06:01:39 -04:00
Joel Spadin ed41d42874 feat(docs): Add aggregated metadata to website
Added /hardware-metadata.json to the ZMK website.
This gives external tools a way to grab all hardware metadata at once.
2022-03-29 23:03:56 -04:00
Peter Johanson b82bbb5ba2 feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
Peter Johanson 47abbe7925 feat(docs): Add dynamic hardware list component. 2021-09-11 00:50:36 -04:00
Peter Johanson 5e6634d2e5 feat(docs): Add TS type gen, metadata JSON gen
* Generate TS types from new hardware metadata schema.
* Aggregate all hw metadata YAML into one aggregate JSON
  file for consumption by others.
2021-09-11 00:50:36 -04:00
Peter Johanson 3f4839ec96 refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
Piotr Gnus 96bd927be2
feat(docs): Added support for prefers-color-scheme in docs
Now, instead of always defaulting to light theme, documentation, docs
will default to the color scheme based by the user preference (reported
by web browser as a `prefers-color-scheme` media query).

It is still possible for user to change the theme by using the switch
next to the search box. His preference will be remembered.
2021-05-05 00:15:38 -04:00
Nick Winans 4ef11ac4aa feat(docs): Add power profiler 2021-03-11 16:31:34 -05:00
innovaker 40694a0969 docs: remove redundant slash from "docs/" navigation item
Aligns with the blog item.

PR: #608
2021-01-30 00:02:11 -05:00
Joel Spadin 5aa8a07aa9 feat(docs): add keymap upgrader
Added a documentation page with a script that upgrades deprecated key
codes and behaviors to their replacements.

Fixes #299
2020-12-10 12:23:05 +00:00
innovaker 532c1987b2 refactor(docs): Move `dev-` documents into `/development`
Aligns to conventions introduced by newer documentation.
2020-11-20 22:31:56 -05:00
innovaker ff638eb010 docs(codes): Add (key) codes documentation
Create codes documentation for standardized keys.

Closes #218.  Fixes #308.  Ref #21.
2020-11-06 15:02:12 -05:00
Pete Johanson 571d045c75 fix(docs): Explicit CC-BY-NC-SA license for docs. 2020-10-26 23:15:48 -04:00
innovaker cd683b8dd6 chore(docs): Replace homePageId with slug: /
Fix warning ...
The docs plugin option homePageId=intro is deprecated. To make a doc the "home", prefer frontmatter: "slug: /"

Follow-up to #286.
2020-10-21 13:52:25 +01:00
Cody McGinnis c3b4525d25 Fix edit url links for the website. 2020-08-13 00:19:59 -04:00
Pete Johanson a6ef1cddec Add analytics. 2020-08-11 16:55:36 -04:00
Pete Johanson 10683fe1f8 Docs re-org, start of some keymap docs. 2020-08-06 15:04:31 -04:00
Pete Johanson 6fd572d3b6 Use `process.env.URL` instead of `DEPLOY_URL`. 2020-08-05 14:58:25 -04:00
Pete Johanson aa21bdd79a Tweak for dynamic invite URL for deploys. 2020-08-05 14:43:59 -04:00
Pete Johanson db586b1ce0 Update to latest V2 Docusaurus. 2020-08-05 14:02:37 -04:00
Pete Johanson 2d99e69eb7
Add Netlify deploy badge 2020-07-21 19:58:34 -04:00
Pete Johanson 22c0558b2f Community link fixes. 2020-07-20 23:39:19 -04:00
Pete Johanson 3cc8b96ac8 Updated link to Discord invite. 2020-07-03 10:45:50 -04:00
Pete Johanson 22238d24de Add Algolia search config. 2020-06-29 10:20:07 -04:00
Pete Johanson c96e705e2e A few more master to main fixes. 2020-06-17 10:38:15 -04:00
innovaker 82d0bd860d docs: Add "sidebarCollapsible: false" 2020-06-14 14:23:48 +01:00
Pete Johanson a952cd6899 Title fix, remove redundant "keyboard". 2020-06-09 23:24:19 -04:00
Pete Johanson e9d7c54b1c New logo and color palette. 2020-06-09 23:18:12 -04:00
Pete Johanson dbabeffa8a Properly reference MIT license consistently. 2020-06-09 09:52:26 -04:00
Pete Johanson 6b48b6dadd Initial cleanup of docs template, GitHub URLs, etc. 2020-06-08 23:10:48 -04:00
Pete Johanson 5304ff9c77 Basic ZMK logo. 2020-06-08 10:46:38 -04:00
Pete Johanson f1afbb8e49 Some basic docs clean up. 2020-05-31 15:35:32 -04:00
Pete Johanson e00408d746 Initial work on basic documentation. 2020-05-25 21:33:21 -04:00