Skip to content

Commit e3bd013

Browse files
committed
bashing things into place
1 parent 02f25d6 commit e3bd013

File tree

21 files changed

+335
-363
lines changed

21 files changed

+335
-363
lines changed

.devcontainer/README.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

.devcontainer/devcontainer.json

Lines changed: 9 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,11 @@
11
{
2-
"name": "Simplicity Lang Documentation",
3-
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
4-
5-
// Features to add to the dev container
6-
"features": {
7-
"ghcr.io/devcontainers/features/git:1": {}
8-
},
9-
10-
// Configure tool-specific properties
11-
"customizations": {
12-
"vscode": {
13-
"settings": {
14-
"python.defaultInterpreterPath": "/usr/local/bin/python",
15-
"python.linting.enabled": true,
16-
"python.linting.pylintEnabled": true,
17-
"python.formatting.provider": "black",
18-
"files.associations": {
19-
"*.md": "markdown"
20-
},
21-
"markdown.preview.breaks": true,
22-
"markdown.preview.linkify": true
23-
},
24-
"extensions": [
25-
"ms-python.python",
26-
"ms-python.pylint",
27-
"ms-python.black-formatter",
28-
"yzhang.markdown-all-in-one",
29-
"davidanson.vscode-markdownlint",
30-
"bierner.markdown-mermaid",
31-
"bierner.markdown-preview-github-styles"
32-
]
33-
}
34-
},
35-
36-
// Use 'forwardPorts' to make a list of ports inside the container available locally
37-
"forwardPorts": [8000],
38-
39-
// Use 'postCreateCommand' to run commands after the container is created
40-
"postCreateCommand": "pip install -r .devcontainer/requirements.txt",
41-
42-
// Configure terminal
43-
"remoteUser": "vscode",
44-
45-
// Mount the workspace
46-
"workspaceFolder": "/workspace",
47-
"mounts": [
48-
"source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=cached"
49-
],
50-
51-
// Set environment variables
52-
"remoteEnv": {
53-
"PYTHONPATH": "/workspace"
54-
}
2+
"name": "Material for MkDocs - VS Code dev container",
3+
"image": "mcr.microsoft.com/devcontainers/typescript-node:0-18",
4+
"features": {
5+
"ghcr.io/devcontainers/features/python:1": {
6+
"installTools": true,
7+
"version": "3.11"
8+
}
9+
},
10+
"postCreateCommand": "pip install -e . && pip install mkdocs-minify-plugin mkdocs-redirects && npm install && npm run build"
5511
}

.devcontainer/requirements.txt

Lines changed: 0 additions & 19 deletions
This file was deleted.

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Enforce Unix newlines
2+
* text=auto eol=lf

.github/copilot-instructions.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Simplicity Documentation Site - AI Coding Assistant Instructions
2+
3+
## Project Overview
4+
This is the documentation site for Simplicity, a typed functional smart contract language for Bitcoin-like blockchains. The site is built with MkDocs Material and focuses on educating developers about Simplicity's tools and implementations.
5+
6+
## Architecture & Key Components
7+
8+
### Documentation Structure
9+
- **Root site**: Built with MkDocs Material (`mkdocs.yml` at root)
10+
- **Content organization**: `docs/` contains markdown files with a hierarchical structure
11+
- **Navigation pattern**: Uses Material's tabbed navigation (`navigation.tabs`) with sections like "Getting Started", "Documentation", etc.
12+
- **Asset management**: Icons use Material Design icons (`:material-*:`) and Simple Icons (`:simple-*:`)
13+
14+
### Deployment Pipeline
15+
- **Build command**: `python -m mkdocs build` (note: always use `python -m` prefix for reliability)
16+
- **Output**: Static site generated to `site/` directory
17+
- **Hosting**: Netlify with configuration in `netlify.toml`
18+
- **Dev environment**: VS Code dev container with Python 3.11 and all dependencies
19+
20+
## Development Workflows
21+
22+
### Local Development
23+
```bash
24+
# Install dependencies
25+
pip install -r requirements.txt
26+
27+
# Serve locally with hot reload
28+
mkdocs serve --dev-addr=0.0.0.0:8000
29+
30+
# Build for production
31+
python -m mkdocs build
32+
```
33+
34+
### Content Creation Patterns
35+
- Use Material Design's card grids for feature showcases: `<div class="grid cards" markdown>`
36+
- Code examples prefer SimplicityHL (Rust-like) syntax with `rust` highlighting
37+
- Tools/implementations tables use Material icons in first column
38+
- Navigation structure follows: Getting Started → Language Docs → Tools → Community
39+
40+
### Key Files & Dependencies
41+
- `requirements.txt`: Pinned MkDocs Material 9.6.18 with specific pymdown-extensions
42+
- `mkdocs.yml`: Extensive Material theme configuration with navigation tabs and search
43+
- `docs/stylesheets/extra.css`: Custom styling for hero sections and cards
44+
- `.devcontainer/`: VS Code development environment with Python + Node.js
45+
46+
## Project-Specific Conventions
47+
48+
### Content Guidelines
49+
- **Tool recommendations**: Always promote WebIDE for beginners, SimplicityHL for development
50+
- **External links**: Point to BlockstreamResearch GitHub organization for implementations
51+
- **Code samples**: Use SimplicityHL syntax, not core Simplicity combinators in getting-started content
52+
- **Navigation flow**: High-level tools → Low-level implementations progression
53+
54+
### Markdown Extensions
55+
- Mermaid diagrams supported via `pymdownx.superfences` custom fences
56+
- YouTube embeds available through custom fence format
57+
- Admonitions and details/summary blocks extensively used
58+
- Tabbed content for multi-language examples
59+
60+
### Icon Usage Pattern
61+
- `:material-lambda:` for Haskell implementation
62+
- `:simple-rust:` for Rust-related tools
63+
- `:material-web:` for WebIDE
64+
- `:material-tools:` for command-line tools
65+
- `:material-microscope:` for formal verification (Coq)
66+

.github/workflows/ci.yaml

Lines changed: 0 additions & 29 deletions
This file was deleted.

.gitignore

Lines changed: 68 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,68 @@
1-
.cache
2-
site
1+
# MkDocs build output
2+
site/
3+
4+
# Python
5+
__pycache__/
6+
*.py[cod]
7+
*$py.class
8+
*.so
9+
.Python
10+
build/
11+
develop-eggs/
12+
dist/
13+
downloads/
14+
eggs/
15+
.eggs/
16+
lib/
17+
lib64/
18+
parts/
19+
sdist/
20+
var/
21+
wheels/
22+
pip-wheel-metadata/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# Virtual environments
30+
.env
31+
.venv
32+
env/
33+
venv/
34+
ENV/
35+
env.bak/
36+
venv.bak/
37+
38+
# IDEs
39+
.vscode/settings.json
40+
.vscode/launch.json
41+
.vscode/extensions.json
42+
.idea/
43+
*.swp
44+
*.swo
45+
*~
46+
47+
# OS generated files
48+
.DS_Store
49+
.DS_Store?
50+
._*
51+
.Spotlight-V100
52+
.Trashes
53+
ehthumbs.db
54+
Thumbs.db
55+
56+
# Logs
57+
*.log
58+
59+
# Temporary files
60+
*.tmp
61+
*.temp
62+
63+
# Node modules (if using any Node.js tools)
64+
node_modules/
65+
66+
# Backup files
67+
*.bak
68+
*.backup

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Simplicity Docs
2+
3+
Building
4+

docs/.gitignore

Lines changed: 0 additions & 68 deletions
This file was deleted.

0 commit comments

Comments
 (0)