# What you will find in these docs

These docs are organized into ten sections, ordered roughly from "what is this?" to "look up the exact flag I need."

## The section map

* [**Introduction**](https://github.com/seal-community/gitbook/blob/main/new-docs/introduction/README.md) (you are here): what Seal is, how it works, who it is for, and the vocabulary used throughout the docs.
* [**Getting started**](/new-documentation/new-docs/sign-up-and-sign-in.md): sign-in, user management, tokens, your first Seal Project, and an end-to-end Proof of Value walkthrough.
* [**Discovering vulnerabilities**](https://github.com/seal-community/gitbook/blob/main/new-docs/discovering/how-discovery-works.md): how Seal finds your packages and how to navigate the platform to triage findings, including the Protection page, package states, and the Repository page.
* [**Using the Seal Platform**](https://github.com/seal-community/gitbook/blob/main/new-docs/using-platform/README.md): the day-to-day operating manual. Sealing Rules, working with each of the five products, the Seal AI Agent, the Seal Engineer, the Notification Center, the Reports Manager, and the Usage page.
* [**Application and OS setup**](https://github.com/seal-community/gitbook/blob/main/new-docs/setup-apps-os/choosing-deployment-method.md): day-1 setup guides for Seal Apps and Seal OS, including the Seal CLI in CI/CD, the Seal Artifact Server, and standalone on-prem environments.
* [**Container and image setup**](https://github.com/seal-community/gitbook/blob/main/new-docs/setup-images-containers/seal-base-images/README.md): day-1 setup guides for Seal Base Images, Seal My Container, and Seal Vendor Apps.
* [**Integrations**](https://github.com/seal-community/gitbook/blob/main/new-docs/integrations/sca-scanners/README.md): connecting Seal to internal SCA scanners, external scanner feeds, JFrog Artifactory, GitHub, and the package renaming feature.
* [**Trust & compliance**](https://github.com/seal-community/gitbook/blob/main/new-docs/trust-compliance/README.md): code diff transparency, attestations, cryptographic signing, the 72-hour SLA, and supported compliance frameworks.
* [**Reference**](https://github.com/seal-community/gitbook/blob/main/new-docs/reference/cli/README.md): CLI commands and flags, Public API, naming and versioning conventions, and network requirements.
* [**FAQ & disclosure**](https://github.com/seal-community/gitbook/blob/main/new-docs/faq.md): frequently asked questions and the vulnerability disclosure policy.

## Find your starting point by role

| Role                 | Focus                                                           | Start here                                                                                      |
| -------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| **Security leader**  | Evaluating Seal; reviewing the Dashboard and reports            | [If you're a security leader](/new-documentation/new-docs/audience-guides/security-leader.md)   |
| **DevOps engineer**  | Setting up integrations; operating the platform side day to day | [If you're a DevOps engineer](/new-documentation/new-docs/audience-guides/devops-engineer.md)   |
| **Developer**        | Integrating the Seal CLI; applying Sealing Rules                | [If you're a developer](/new-documentation/new-docs/audience-guides/developer.md)               |
| **Security analyst** | Day-to-day triage, notifications, and reports for leadership    | [If you're a security analyst](/new-documentation/new-docs/audience-guides/security-analyst.md) |

The DevOps guide also covers DevSecOps and platform engineers; everyone responsible for the platform side of operating Seal in your organization.

## Key terms

Seal uses a precise vocabulary across these docs. The most common terms you will encounter:

* A **sealed package** is a drop-in replacement for a public package version, with security fixes backported in.
* A **Sealing Rule** tells Seal which package to replace and with which sealed version.
* A **Seal Project** is the entity inside the Seal Platform that represents one of your codebases or build pipelines.
* The **package discovery mode** of a Seal Project determines how Seal sees your packages: source code, CLI, artifact server, or imported manifest.
* A **deployment method** is how Seal is integrated into your environment, for example the Seal CLI in CI/CD, or the Seal Artifact Server as a configured remote.
* The **CLI fix mode** is the mode the Seal CLI runs in: **local** mode (rules from a `.seal-actions.yml` file in your source), **remote** mode (rules from the Seal Platform UI), or **all** mode (every vulnerable package replaced automatically).

The full vocabulary is in the [Glossary](/new-documentation/new-docs/glossary.md).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sealsecurity.io/new-documentation/new-docs/navigating-the-docs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
