de8b827562
Adds metadataBase, og:image, og:url, Twitter card tags, canonical URL, sitemap.ts, robots.ts with AI crawler directives, and llms.txt.
23 lines
1.3 KiB
Plaintext
23 lines
1.3 KiB
Plaintext
# CodeBoard
|
|
|
|
> CodeBoard is a developer tool that generates interactive onboarding documentation from any GitHub repository. Paste a URL and get architecture diagrams, module breakdowns, and getting started guides in minutes.
|
|
|
|
CodeBoard uses AI to analyze codebases and produce structured documentation that helps new developers understand unfamiliar projects quickly. It generates visual architecture diagrams, identifies key modules and their relationships, and creates step-by-step getting started guides.
|
|
|
|
## Product
|
|
|
|
- [CodeBoard App](https://codeboard.vectry.tech): Paste a GitHub URL to generate documentation
|
|
- [Source Code](https://gitea.repi.fun/repi/codeboard): Repository on Gitea
|
|
|
|
## Features
|
|
|
|
- **Architecture Diagrams**: Auto-generated visual maps of codebase structure and dependencies
|
|
- **Module Breakdowns**: Detailed analysis of each major component with purpose and key files
|
|
- **Getting Started Guides**: Step-by-step instructions for setting up and running the project
|
|
- **Technology Detection**: Identifies frameworks, languages, and tools used in the project
|
|
|
|
## Optional
|
|
|
|
- [Vectry](https://vectry.tech): Built by Vectry, an engineering-first AI consultancy
|
|
- [AgentLens](https://agentlens.vectry.tech): Sister product — open-source agent observability platform
|