Repository navigation
docs: document the app with real screenshots and known limitations - #17
Merged
Merged
Conversation
Rewrite the README around the actual running product instead of the
aspirational one, and add a screenshots/ gallery (17 captures, 1600x1000)
generated from a live local stack with real data.
Content:
- How it works: the five-step flow from project creation to a navigable
graph, with scope enforcement checked before execution.
- Getting started: verified commands, the required BullMQ worker process
(a run stays queued without it), healthcheck and port map.
- Adapters and scope: the four registered adapters (stub, nmap, ffuf,
nuclei) and the 403 SCOPE_VIOLATION behaviour on an out-of-scope target.
- Known limitations, measured rather than assumed:
* The Graph tab renders nothing because the React Flow container collapses
to height 0 (measured 1600x0) even though the API returns the nodes and
use-project-graph reads them correctly. Commit 148c9 (BUG #7) already
tried to fix this with absolute inset-0, so this looks like a regression.
The Timeline tab mounts the same engine with correct dimensions and is
used for the graph captures.
* /docs returns 404 although the navbar links to it.
* Report assembly is blocked by the above: the builder requires selecting
at least one graph node.
* pnpm seed creates demo@attacksurfacestudio.dev with a literal
"seed-placeholder" hash instead of an Argon2id hash, so that login can
never succeed.
Also drop the links to .claude/ARCHITECTURE.md, DATA_MODEL.md,
SECURITY_MODEL.md and INTEGRATION_SYSTEM.md: those files are not in the
repository, so the old links were dead. Point the section at what exists.
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
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.
Rewrite the README around the actual running product instead of the aspirational one, and add a screenshots/ gallery (17 captures, 1600x1000) generated from a live local stack with real data.
Content:
Also drop the links to .claude/ARCHITECTURE.md, DATA_MODEL.md, SECURITY_MODEL.md and INTEGRATION_SYSTEM.md: those files are not in the repository, so the old links were dead. Point the section at what exists.