Skip to content

Redesign docs site and configure beamtalk.dev #1007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesc merged 3 commits into from
Feb 28, 2026
Merged

Redesign docs site and configure beamtalk.dev #1007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c324fa
docs: redesign documentation site with modern design and custom domain
jamesc Feb 28, 2026
53672e1
fix: address CodeRabbit review comments on docs site
jamesc Feb 28, 2026
e9f8496
fix: use "./" prefix on landing page so site nav links render
jamesc Feb 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ jobs:
- name: Copy install script to site root
run: cp scripts/install.sh _site/install.sh

- name: Write CNAME for custom domain
run: echo "beamtalk.dev" > _site/CNAME

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v4

Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Beamtalk is a Smalltalk/Newspeak-inspired language compiling to BEAM via Rust. T
- **Structured errors:** Use `#beamtalk_error{}` for all user-facing/public API errors. Internal runtime helpers may use `{ok, Value} | {error, Reason}` if translated at public boundaries.
- **Codegen:** All Core Erlang codegen MUST use `Document` / `docvec!` API. **NEVER use `format!()` or string concatenation to produce Core Erlang fragments — not even for "simple" atoms, arities, or map keys.** This rule has been violated repeatedly and required a dedicated cleanup effort (BT-875). Do not reintroduce violations.
- **Erlang logging:** Use OTP logger macros (`?LOG_ERROR`, etc.), never `io:format` or `logger:error()`.
- **License headers:** All source files need `Copyright 2026 James Casey` / `SPDX-License-Identifier: Apache-2.0`.
- **License headers:** All source **code** files (`.rs`, `.erl`, `.bt`, `.hrl`) need `Copyright 2026 James Casey` / `SPDX-License-Identifier: Apache-2.0`. Do **not** add license headers to `.md` files.
- **Implicit returns:** Use `^` ONLY for early returns, never on last expression.
- **Test assertions:** Every expression in test files MUST have a `// =>` assertion (even `// => _`). No assertion = no execution.

Expand Down
Loading