Repository navigation
docs: user guide and role-based entry points for new users and admins - #242
Merged
Merged
Conversation
…admins README becomes a landing page with a start-here table and a correct development setup (incl. Arduino CLI). New docs/USER_GUIDE.md covers the browser UI, examples and the Tutor. INSTALL_SERVER gains an Nginx example, course content and Tutor variables, a backup section and a clearer capacity explanation. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…243 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Result of a review of the documentation from the perspective of a new user and a new admin.
npm run build && npm run start, "available at localhost:3000" without a gateway) is replaced by links to the install guides. Features list Examples and Tutor; small language and typo fixes.docs/USER_GUIDE.md(German): writing and running sketches, saving files, loading examples, choosing a browser-scoped examples repository, enabling the Tutor (Experimental Workspace Layout), entering the personal KI:connect key (kept in tab memory only), troubleshooting. All UI labels were checked against the client code.docs/INSTALL_SERVER.md: note that direct backend calls without a gateway are rejected by design; generic Nginx example (same as the VBox installer); table of course content and Tutor variables; backup section (no user data on the server; what to back up); rewritten capacity explanation (SIMULATION_MAX_CONCURRENTvs.SIMULATION_ADMISSION_MAX).docs/README.md: new "Nutzung" section and a pointer to the shortest installation path.Test plan
npm run check:docs(93 files)./run-tests.sh– all 11 stages green🤖 Generated with Claude Code