> ## Documentation Index
> Fetch the complete documentation index at: https://docs.woes.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Knowledge

> Planned API Context, source ingestion, endpoint evidence, and testing categories for the Woes public API.

Knowledge APIs will cover the source material Woes uses to ground support answers. This is the API surface for source ingestion, scan health, endpoint evidence, and test readiness.

## Planned resources

| Resource            | Description                                                              |
| ------------------- | ------------------------------------------------------------------------ |
| Sources             | API docs, specs, JSON files, Markdown, or websites added to API Context. |
| Scan status         | Current ingestion state, failures, and coverage counts.                  |
| Endpoint records    | Parsed methods, paths, parameters, schemas, examples, and metadata.      |
| Generated Markdown  | AI-readable endpoint evidence.                                           |
| Retrieval chunks    | Searchable source fragments used for grounded answers.                   |
| Credential metadata | Non-secret auth status for testing and verification.                     |
| Test summaries      | Safe summaries of test results and coverage.                             |

## Source categories

<CardGroup cols={2}>
  <Card title="OpenAPI" icon="file-code">
    Best for endpoint contracts, schemas, parameters, requests, responses, and auth metadata.
  </Card>

  <Card title="Markdown" icon="file-text">
    Best for guides, examples, troubleshooting, and behavior explanations.
  </Card>

  <Card title="JSON" icon="braces">
    Best for structured endpoint or schema exports from internal tools.
  </Card>

  <Card title="Website" icon="globe">
    Best for published documentation that needs to be crawled or imported.
  </Card>
</CardGroup>

## Common use cases

* Add or rescan documentation sources.
* Check whether ingestion succeeded.
* Review endpoint coverage from an internal dashboard.
* Detect stale or partial context.
* Trigger documentation workflows when scans fail.
* Compare support questions with missing source coverage.

## Boundaries

API credentials used for testing should stay separate from source content. Public API responses should not return stored credential values in plaintext.

Endpoint-level docs should make it clear which knowledge APIs are read-only, which mutate source state, and which can trigger scans.