Skip to content

Update readme - #268

Merged
VictoriaRuckerbauer merged 40 commits into
mainfrom
update-readme
Aug 27, 2026
Merged

Update readme#268
VictoriaRuckerbauer merged 40 commits into
mainfrom
update-readme

Conversation

@VictoriaRuckerbauer

Copy link
Copy Markdown
Contributor

What

Update and restructure documentation

Why

Previous documentation was out-of-date and too long for humans to read

@VictoriaRuckerbauer
VictoriaRuckerbauer force-pushed the update-readme branch 2 times, most recently from 29b66a7 to f60cdc3 Compare August 27, 2026 14:44
Comment thread README.md Outdated
Comment thread CLAUDE.md
VictoriaRuckerbauer and others added 27 commits August 27, 2026 16:51
- clear list of supported OS+harness combinations required for readme
- automated testing for WSL has some gaps
- these changes allow more automated tests for WSL

Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Mathias Wagner <mathias.wagner@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
- mention WSL update
- provide reliable and tested keyring setup instructions
- update error message on corresponding failures to reflect the new docs

Signed-off-by: Mathias Wagner <mathias.wagner@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
- own experience: getting Claude to read the AGENTS.md does not work well, so duplicate it rather then having Claude not read instructions
- add instructions to get the agent to reply concisely to speed up devs

Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
…cation

Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
…created)

Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
Signed-off-by: Victoria Ruckerbauer <victoria.ruckerbauer@tngtech.com>
@VictoriaRuckerbauer
VictoriaRuckerbauer merged commit ff20fd9 into main Aug 27, 2026
10 checks passed
@VictoriaRuckerbauer
VictoriaRuckerbauer deleted the update-readme branch August 27, 2026 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants