Skip to content

docs: document the app with real screenshots and known limitations - #17

Merged
Alex350-coder merged 1 commit into
mainfrom
docs/readme-screenshots
Sep 27, 2026
Merged

Alex350-coder merged 1 commit into
mainfrom
docs/readme-screenshots

Conversation

@Alex350-coder

Copy link
Copy Markdown
Owner

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 Frontend workspace phase9 #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.

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.
@Alex350-coder
Alex350-coder merged commit 6bb8f7a into main Sep 27, 2026
1 of 2 checks passed
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.

1 participant