Skip to content

Commit 772a648

Browse files
ktappdevktappdev
committed
docs: add GitHub Pages getting started site
1 parent 7a8b120 commit 772a648

6 files changed

Lines changed: 2109 additions & 0 deletions

File tree

‎.github/workflows/pages.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "docs/**"
8+
- ".github/workflows/pages.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: github-pages
18+
cancel-in-progress: true
19+
20+
jobs:
21+
deploy:
22+
runs-on: ubuntu-latest
23+
environment:
24+
name: github-pages
25+
url: ${{ steps.deployment.outputs.page_url }}
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
29+
30+
- name: Configure GitHub Pages
31+
uses: actions/configure-pages@v5
32+
33+
- name: Upload site artifact
34+
uses: actions/upload-pages-artifact@v4
35+
with:
36+
path: docs
37+
38+
- name: Deploy to GitHub Pages
39+
id: deployment
40+
uses: actions/deploy-pages@v4

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
Contexting keeps a live map of your codebase so AI agents can reason about paths without hunting through the filesystem manually. It builds a recursive JSON tree of every folder and file, extracts code symbols (functions, classes, types, variables) using language-specific extractors, attaches LLM-generated synonyms, and exposes ranked search hints plus health tooling.
66

7+
Read the visual [getting started guide](https://ktappdev.github.io/contexting/) for the product story, architecture, installation paths, MCP setup, and privacy notes.
8+
79
## Quick start
810

911
`ctxt` supports Linux, macOS, and Windows on amd64 and arm64. Download the

‎docs/404.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<title>Page not found · Contexting</title>
7+
<link rel="stylesheet" href="site.css">
8+
</head>
9+
<body>
10+
<main class="shell section-pad not-found-page">
11+
<div class="not-found-intro">
12+
<p class="eyebrow"><span class="eyebrow-line" aria-hidden="true"></span> 404 <span class="eyebrow-line" aria-hidden="true"></span></p>
13+
<h1>That path is not in the map.</h1>
14+
<p class="hero-lede not-found-lede">The page you’re looking for may have moved. The project home is still right here.</p>
15+
<a class="button button-primary" href="./">Back to Contexting <span aria-hidden="true">↗</span></a>
16+
</div>
17+
</main>
18+
</body>
19+
</html>

0 commit comments

Comments
 (0)