Skip to content

docs: add enterprise badges and VitePress documentation site#7

Merged
jessn-dev merged 1 commit into
mainfrom
develop
Jun 26, 2026
Merged

docs: add enterprise badges and VitePress documentation site#7
jessn-dev merged 1 commit into
mainfrom
develop

Conversation

@jessn-dev

Copy link
Copy Markdown
Owner
  • Expanded README with comprehensive, high-visibility enterprise badges.

  • Scaffolded a complete VitePress documentation site under docs/.

  • Added structured guides for installation, configuration, and MCP server usage.

  • Included a GitHub Actions workflow to auto-deploy the docs to GitHub Pages.

- Expanded README with comprehensive, high-visibility enterprise badges.

- Scaffolded a complete VitePress documentation site under `docs/`.

- Added structured guides for installation, configuration, and MCP server usage.

- Included a GitHub Actions workflow to auto-deploy the docs to GitHub Pages.
@jessn-dev

Copy link
Copy Markdown
Owner Author
This pull request completely overhauls our project documentation by introducing a modern, fully-featured documentation site and upgrading our repository landing page.

### 🛡️ Enterprise Badges
- Replaced the default `README.md` badges with a bold, high-visibility block.
- Added comprehensive trackers for NPM Version & Downloads, Node.js version, CI Status, TypeScript, Semantic Release, License, and PRs.
- Included an active **Snyk Vulnerabilities badge** (accurately linked to our NPM registry) and a dynamic **Visitor Traffic tracker**.

### 📚 VitePress Documentation Site
- **Scaffolded VitePress** in the `docs/` directory featuring a beautiful, responsive home page.
- **Overhauled Guides:** Authored professional, technical-writing-standard pages for:
  - Architecture Introduction & Context Problem Rationale
  - Getting Started (Initialization, Validation, Packing)
  - Configuration & Manifest (`agenticscope.toml` semantics)
  - MCP Server Integration & Security boundaries
- **Explicit Client Support:** Clarified that advanced clients (Windsurf, Zed, Claude Desktop) can bypass static files natively by querying the MCP server, and explicitly detailed our universal compilation targets (`.cursorrules`, `CLAUDE.md`, `GEMINI.md`, `AGENTS.md`).

### 🚀 Automated Deployment
- Added npm scripts (`docs:dev`, `docs:build`, `docs:preview`) to `package.json`.
- Integrated a GitHub Actions workflow (`deploy-docs.yml`) to automatically build and deploy the VitePress site to **GitHub Pages** whenever code is merged into `main`.

@jessn-dev jessn-dev merged commit a30d1aa into main Jun 26, 2026
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