docs: quickstart + glossary + architecture + trace format + CLI reference + scenarios#46
Merged
Merged
Conversation
…ence + scenarios - /docs index with navigation sidebar - /docs/quickstart: install, inspect, report, scenario, web inspector, programmatic use - /docs/glossary: OCPP, CSMS, Charge Point, Connector, Transaction, Call types, idTag, Trace, Direction - /docs/architecture: package structure, dependency graph, data flow, browser-local processing, tech stack - /docs/trace-format: JSON Object, JSONL, bare array, message structure, timestamps, limits, direction inference - /docs/cli: install, inspect, report, scenario list, scenario run, options, security - /docs/scenarios: 5 built-in scenarios, failure detection rules, running scenarios, synthetic data Closes #31
sepehr-safari
added
type:docs
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
Adds documentation content to the web app — 7 doc pages covering all key topics for v0.1.0.
Closes #31
Changes
New pages
/docs— index with navigation sidebar and links to all doc pages/docs/quickstart— CLI install, inspect, report, scenario commands, web inspector, programmatic core library usage/docs/glossary— OCPP, CSMS, Charge Point, Connector, Transaction, Call/CallResult/CallError, idTag, Trace, Direction/docs/architecture— package structure, dependency graph, data flow (parse → analyze → report), browser-local processing, tech stack/docs/trace-format— JSON Object, JSONL, bare array formats, OCPP message structure, timestamp formats, limits, direction inference/docs/cli— full CLI reference: inspect, report, scenario list, scenario run, options, security/docs/scenarios— 5 built-in scenarios, 3 failure detection rules, running scenarios, synthetic data policyLayout
/docs/layout.tsx— shared docs layout with navigation sidebarVerification
pnpm lint— ✅pnpm typecheck— ✅pnpm test— ✅ (196 tests)pnpm build— ✅ (10 routes prerendered)pnpm format:check— ✅