docs: fill three empty pages and fix broken internal links#10
Merged
caffix merged 1 commit intoowasp-amass:masterfrom Mar 1, 2026
Merged
Conversation
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>
dafe4de to
6ce1e8f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 --strictpasses with 0 warnings after these changes.New content (3 empty pages filled)
docs/contributing/contributing.md— was 2 blank linesgit remote, branch/PR rules (developbranch, no force-push, rebase before PR)CGO_ENABLED=0and Go 1.26.0 requirementsMin/Mid/High/MaxHandlerInstances)engine/plugins/api/chaos.goas the canonical minimal example: Plugin interface, RegisterHandler fields, annotated Callback pattern,load.goregistration,datasources.yamltemplatedocs/asset_db/index.md— was 1 blank lineconfig.yamland environment variablespostgres.mdandtriples.mddocs/data_sources/data_sources.md— was entirely emptydatasources.yamlcredential setup with four format examples: API key only, username + API key, username + password, multiple accountsresources/datasources.yamlin the amass repo)Broken link fixes (5 pages)
open_asset_model/relations/index.md../framework_tools/assoc.md— page does not existopen_asset_model/relations/index.md../assetdb/triples.md— wrong relative path../../asset_db/triples.md(×2)open_asset_model/properties/index.mdopen_asset_model/assets/index.mdopen_asset_model/assets/identifier.md./contact_record.md.md— double extension typo./contact_record.mdasset_db/postgres.md../configuration/configuration.md— file does not exist../configuration/index.mdVerification