Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
assets
assets
 
 
COMPANY_STANDARDS.md
COMPANY_STANDARDS.md
 
 
GLOSSARY.md
GLOSSARY.md
 
 
MCP.md
MCP.md
 
 
OPS.md
OPS.md
 
 
README.md
README.md
 
 

README.md

Site Audit — Documentation

This directory contains product, integration, and operations documentation for Site Audit (repository: WebsiteProfiling), a self-hosted SEO crawl and technical audit platform.

Document index

Document Audience Description
README.md All users Product overview, installation, configuration
CONTRIBUTING.md Contributors Development setup, testing, pull request guidelines
AGENT.md Developers Repository layout, APIs, edit targets
GLOSSARY.md Product / UX UI terminology mapped to internal keys and data sources
COMPANY_STANDARDS.md Agencies / operators Data classification, crawl scope, security policy
MCP.md Integrators Model Context Protocol server configuration and tool reference
OPS.md Operators Scheduled audits, alerts, migrations, production notes

Brand assets

Marketing and README assets are stored in assets/:

Asset Purpose
readme-banner.png README header banner
social-preview.png Application screenshot for README and social previews
banner.svg Source artwork for the banner
logo.svg, logo-icon.svg Product logo and icon
icon-crawl.svg, icon-audit.svg, icon-integrations.svg, icon-self-hosted.svg Feature icons for README

Related repository files

File Description
SECURITY.md Vulnerability reporting policy
CODE_OF_CONDUCT.md Community standards
pipeline-config.example.txt Pipeline configuration key reference