Skip to content

docs: Complete documentation overhaul for ShipSec Studio#304

Open
LuD1161 wants to merge 4 commits intomainfrom
changes
Open

docs: Complete documentation overhaul for ShipSec Studio#304
LuD1161 wants to merge 4 commits intomainfrom
changes

Conversation

@LuD1161
Copy link
Contributor

@LuD1161 LuD1161 commented Feb 20, 2026

Pages updated:
quickstart · installation · command-reference · architecture · components/overview · components/core · components/security · components/ai · development/isolated-volumes

What changed:

  • Rewrote all pages with proper Mintlify components (<Card>, <CardGroup>, <Note>, <Warning>, <Tip>, <Accordion>, <Steps>)
  • Added Previous → Next navigation to every page
  • Replaced ASCII architecture diagram with a custom animated SVG
  • Consistent tone, scannable structure, non-technical friendly
  • <Warning> callouts on all destructive commands
  • Fixed table spacing to prevent sidebar parse errors

Mintlify

0 threads from 0 users in Mintlify

  • No unresolved comments

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6e3481d254

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

| Parameter | Type | What it does |
|---|---|---|
| `indexSuffix` | String | Custom suffix appended to the index name. Defaults to the workflow name. |
| `assetKeyField` | Select | Which field to use as the asset identifier. Options: `auto`, `host`, `domain`, `subdomain`, `url`, `ip`, `asset`, `target`, `custom` |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Include asset_key in Analytics Sink option docs

The rewritten options list for assetKeyField now omits asset_key, but the component still accepts it (worker/src/components/core/analytics-sink.ts enum/options). This makes the docs inaccurate for users whose findings already use asset_key, and can lead them to configure custom unnecessarily or assume the built-in mapping is unsupported.

Useful? React with 👍 / 👎.

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

Comments