feat: add Documentation page (#76) - #82
Merged
Merged
Conversation
- New /docs route with DocsPage covering:
- Overview: what the tool does and how it's deployed
- How scans work: ARP → nmap → DNS → OS inference → risk analysis
- Risk levels: Critical/High/Medium/Low/Info with plain-language descriptions
- Configuration: env var reference with minimal docker-compose example
- How-to guides: set hostname on Linux/macOS/Windows/Raspberry Pi/router DHCP,
mark trusted devices, get best scan results
- Add 'Docs' nav link in Layout.tsx between Recommendations and Settings
- Static page, no API calls
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.
Closes #76
What
Adds a new
/docsroute with a full in-app Documentation page and a Docs nav link between Recommendations and Settings.Content
docker-compose.ymlexampleImplementation notes
tsc && vite buildpass cleanly