18 Commits

Author SHA1 Message Date
Jesse Vincent
d895acff48 move the releng doc into the codebase subdir 2024-05-28 11:21:21 -07:00
Jesse Vincent
146f2de8f6 update maintainers page to have a few more words and to identify me as the right point of contact. Fixes #1428 2024-05-28 11:21:21 -07:00
Michael Richters
f8237165c1 Add documentation for format-code.py and iwyu.py
I put this in the code style guide, for lack of a better place.

Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2022-05-08 12:48:59 -05:00
Michael Richters
8af3584ea8 Update code style docs with IWYU info
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2022-04-06 19:25:32 -05:00
Michael Richters
5d5ad0871d Update code style documentation from astyle to clang-format
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2022-04-06 18:44:14 -05:00
Michael Richters
54ca31f959 Update code style guide for header include updates
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2022-03-22 11:52:18 -07:00
Jesse Vincent
f5bbd61784 Simplify our docker execution (#1124)
* Switch docker to no longer build a bundle separate from the kaleidoscope
dir.
Stop copying over a bunch of tarballs we don't need.

* fix shellcheck

* Stop copying the core-bundled copies of Kaleidoscope over to docker

* Symlink our Kaleidoscope into the versions packaged into the arduino
cores when running in docker. We need to do this to satisfy the
sketch_header.h/sketch_footer.h system we use to be able to amend
arduino sketches on avr and virtual. (This feature is not used by the
core and may be removed in the future)

* Reimplement docker-clean to do much less work and get the same result

* Add a stub at docs for the docker test runner
2022-03-05 19:19:20 -08:00
Michael Richters
6bdcd01080 Add glossary entries for LiveKeys special values
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2021-05-28 16:12:58 -05:00
Michael Richters
9d06843bd2 Update documentation for keyboard state array changes
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2021-05-28 14:51:52 -05:00
Jesse Vincent
8f23161d19 Glossary updates for terms related to keymaps, layers, and keys.
@algernon and I have been hashing out a set of terminology over the past week. While this is still fairly incomplete, it is hopefully an improvement on the previous undocumented state of things.
2020-12-31 19:12:11 -08:00
Jesse Vincent
e2bee6cace Bring testing up a level and kill the "development tips" doc section 2020-12-31 14:50:32 -08:00
Eric Paniagua
fad1b7e051 Add a googletest-based test harness & tests
This adds a googletest-based test harness (with googletest pulled into
`testing/googletest`, so we have a fixed state of it), and a few test
cases that demonstrate its use.

Original work by Eric Paniagua in #898, with minor cleanups by Gergely
Nagy.

Signed-off-by: Eric Paniagua <epaniagua@google.com>
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
2020-09-25 22:19:01 +02:00
Eric Paniagua
83aeaac8a5 Wordsmith "Understanding the Codebase" up to Multiple Inheritance
Signed-off-by: Eric Paniagua <epaniagua@google.com>
2020-08-28 07:00:39 -07:00
Jesse Vincent
fb8a9aa25b Add a title for the design philosophy 2020-06-08 22:30:38 -07:00
Jesse Vincent
1472af7ba8 Migrate "release testing" from the wiki 2020-06-08 22:27:25 -07:00
Jesse Vincent
ca06492a89 Add a "design philosophy" doc migrated from the wiki 2020-06-08 22:21:08 -07:00
Jesse Vincent
e9f03ddd5b Remove the term 'blacklist' from an example in the coding style guide 2020-06-07 23:39:56 -07:00
Jesse Vincent
a60651054a Move most of our docs into the 'docs' directory as we being Read The Docs setup 2020-01-03 15:40:10 -08:00