Skip to content

docs: fill three empty pages and fix broken internal links#10

Merged
caffix merged 1 commit intoowasp-amass:masterfrom
The-Inceptions:docs/fill-empty-pages-and-fix-broken-links
Mar 1, 2026
Merged

docs: fill three empty pages and fix broken internal links#10
caffix merged 1 commit intoowasp-amass:masterfrom
The-Inceptions:docs/fill-empty-pages-and-fix-broken-links

Conversation

@The-Inceptions
Copy link
Copy Markdown
Member

Summary

Three documentation pages were empty and five pages contained broken internal links. This PR fills the content and fixes all broken links. mkdocs build --strict passes with 0 warnings after these changes.


New content (3 empty pages filled)

docs/contributing/contributing.md — was 2 blank lines

  • Git workflow: forking with git remote, branch/PR rules (develop branch, no force-push, rebase before PR)
  • Build & test commands with CGO_ENABLED=0 and Go 1.26.0 requirements
  • Engine architecture section with a Mermaid flowchart (REST API → Session Backlog → Dispatcher → PipelinePool → Pipeline Stages → Handler Callback)
  • Key component descriptions: SessionManager, Registry, Dispatcher, PipelinePool, Backlog
  • Handler instance constants table (Min/Mid/High/MaxHandlerInstances)
  • Full plugin authoring guide (5 steps) based on engine/plugins/api/chaos.go as the canonical minimal example: Plugin interface, RegisterHandler fields, annotated Callback pattern, load.go registration, datasources.yaml template
  • Support utilities reference table

docs/asset_db/index.md — was 1 blank line

  • What the asset database is and how it relates to Sessions and the Open Asset Model
  • Supported backends table: SQLite (default), PostgreSQL, Neo4j with connection string formats
  • Configuration via config.yaml and environment variables
  • How it fits into the broader data model
  • Links to postgres.md and triples.md

docs/data_sources/data_sources.md — was entirely empty

  • Explanation of what data sources are (API plugins, scrapers, WHOIS/RDAP)
  • datasources.yaml credential setup with four format examples: API key only, username + API key, username + password, multiple accounts
  • Global TTL options
  • Complete reference table for all 38 data sources with credential type and default TTL (sourced from resources/datasources.yaml in the amass repo)

Broken link fixes (5 pages)

File Problem Fix
open_asset_model/relations/index.md ../framework_tools/assoc.md — page does not exist Removed (×2 locations)
open_asset_model/relations/index.md ../assetdb/triples.md — wrong relative path ../../asset_db/triples.md (×2)
open_asset_model/properties/index.md Same two broken links Same fixes
open_asset_model/assets/index.md Same two broken links Same fixes
open_asset_model/assets/identifier.md ./contact_record.md.md — double extension typo ./contact_record.md
asset_db/postgres.md ../configuration/configuration.md — file does not exist ../configuration/index.md

Verification

mkdocs build --strict
→ Documentation built in 0.97 seconds (0 warnings)

Three pages were empty/blank and are now fully written:
- contributing/contributing.md: developer guide covering git workflow,
  build/test commands, engine architecture (mermaid diagram), and a
  step-by-step plugin authoring guide based on engine/plugins/api/chaos.go
- asset_db/index.md: asset database overview with supported backends
  (SQLite/PostgreSQL/Neo4j), configuration, and how it fits together
- data_sources/data_sources.md: credentials setup guide and a full
  reference table for all 38 data sources with credential types and TTLs

Five pages had broken internal links which are now fixed:
- open_asset_model/relations/index.md: removed two references to
  ../framework_tools/assoc.md (page does not exist); corrected
  ../assetdb/triples.md → ../../asset_db/triples.md (wrong path)
- open_asset_model/properties/index.md: same two fixes as above
- open_asset_model/assets/index.md: same two fixes as above
- open_asset_model/assets/identifier.md: fixed double extension typo
  contact_record.md.md → contact_record.md
- asset_db/postgres.md: fixed ../configuration/configuration.md →
  ../configuration/index.md (file does not exist at that path)

Verified with: mkdocs build --strict (0 warnings)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@The-Inceptions The-Inceptions force-pushed the docs/fill-empty-pages-and-fix-broken-links branch from dafe4de to 6ce1e8f Compare February 23, 2026 05:43
Copy link
Copy Markdown
Collaborator

@caffix caffix left a comment

Choose a reason for hiding this comment

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

Thanks!

@caffix caffix merged commit 80d0f85 into owasp-amass:master Mar 1, 2026
0 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.

2 participants