This guide explains how to update the CodeGraphContext documentation website.
CodeGraphContext has two separate web properties:
- Location:
/docs/ - URL: https://CodeGraphContext.github.io/CodeGraphContext/
- Purpose: Technical documentation, guides, API reference
- Technology: MkDocs with Material theme
- Location:
/website/ - URL: https://codegraphcontext.vercel.app/ (or similar)
- Purpose: Marketing, features showcase, quick start
- Technology: React + Vite + TypeScript
cd docs
pip install mkdocs-material
mkdocs serve # Preview at http://127.0.0.1:8000docs/
├── mkdocs.yml # Configuration & navigation
├── docs/ # Markdown content
│ ├── index.md
│ ├── installation.md
│ ├── cookbook.md
│ └── ...
└── deployment/ # Deployment guides (NEW!)
├── README.md
├── DOCKER_README.md
└── ...
-
Create a markdown file in
docs/docs/:touch docs/docs/my-new-page.md
-
Add to navigation in
docs/mkdocs.yml:nav: - My New Page: my-new-page.md
-
Preview changes:
cd docs && mkdocs serve
cd docs
mkdocs build # Generates static site in docs/site/
mkdocs gh-deploy # Deploys to GitHub Pagescd website
npm install
npm run dev # Preview at http://localhost:5173src/pages/Index.tsx- Main landing pagesrc/components/HeroSection.tsx- Hero bannersrc/components/FeaturesSection.tsx- Features listsrc/components/InstallationSection.tsx- Installation guidesrc/components/Footer.tsx- Footer links (just updated!)src/components/CookbookSection.tsx- Code examples
cd website
npm run build # Generates dist/ folder- ✅ Moved deployment docs from root to
docs/deployment/ - ✅ Updated
docs/mkdocs.ymlto include deployment section - ✅ Updated
website/src/components/Footer.tsxto link to deployment docs - ✅ Created
docs/deployment/README.mdas navigation index
-
Test MkDocs locally:
cd docs mkdocs serve # Visit http://127.0.0.1:8000 and check the "Deployment" section
-
Deploy to GitHub Pages:
cd docs mkdocs gh-deploy -
Update React site (if needed):
cd website npm run build # Deploy to Vercel/Netlify/etc.
- MkDocs Documentation: https://www.mkdocs.org/
- Material Theme: https://squidfunk.github.io/mkdocs-material/
- Current Docs Site: https://CodeGraphContext.github.io/CodeGraphContext/
- MkDocs uses relative paths from
docs/docs/directory - Use
../deployment/FILE.mdto reference files outsidedocs/docs/ - The React site links to GitHub for docs (see Footer.tsx)
- TypeScript errors in
website/are normal withoutnpm install