Skip to content

Commit d966b22

Browse files
committed
docs: move and adapt the other chapters of Stan's docs suitable for public docs
also added `just serve-docs`
1 parent b7d2a3a commit d966b22

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+217
-1298
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ build-*/
1111
.direnv/
1212
result
1313

14-
docs/experimental-documentation/build/*
14+
docs/book/book
1515
src/index.js
1616
ui.js
1717
debugger.js

ci/deploy/docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
set -e
44

5-
pushd docs/experimental-documentation/mdbook-ct
5+
pushd docs/book/
66

77
# TODO: eventually: a more fine-grained nix shell/env?
88
# nix-shell --command "mdbook build"

docs/experimental-documentation/mdbook-ct/book.toml renamed to docs/book/book.toml

File renamed without changes.

docs/experimental-documentation/mdbook-ct/shell.nix renamed to docs/book/shell.nix

File renamed without changes.

docs/book/src/SUMMARY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Summary
2+
3+
- [Introduction](./introduction.md)
4+
5+
## Usage guide
6+
7+
- [Intro to usage guide](./usage_guide/intro_to_usage.md)
8+
- [CLI](./usage_guide/CLI.md)
9+
- [Basic GUI](./usage_guide/basic_gui.md)
10+
- [Tracepoints](./usage_guide/tracepoints.md)
11+
- [CodeTracer Shell](./usage_guide/codetracer_shell.md)
12+
13+
## Backends
14+
15+
- [DB backend](./backends/db_backend.md)
16+
- [Noir](./backends/db-backend/noir.md)
17+
- [Ruby](./backends/db-backend/ruby.md)
18+
- [Python](./backends/db-backend/py.md)
19+
- [Lua](./backends/db-backend/lua.md)
20+
- [small](./backends/db-backend/small.md)
21+
22+
- [RR backend](./backends/rr_backend.md)
23+
- [C & C++](./backends/rr-backend/c_and_cpp.md)
24+
- [Rust](./backends/rr-backend/rust.md)
25+
- [Nim](./backends/rr-backend/nim.md)
26+
- [Go](./backends/rr-backend/go.md)
27+
28+
## Building & packaging
29+
30+
- [Build systems](./building_and_packaging/build_systems.md)
31+
32+
### Misc
33+
34+
- [Troubleshooting](./misc/troubleshooting.md)
35+
- [Environment variables](./misc/environment_variables.md)
36+
- [Building the documentation](./misc/building_docs.md)
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Lua
2+
3+
We still don't have Lua support, however we've had a very minimal proof of concept experiment with supporting Lua (the interpreter, not LuaJIT) with our RR backend years ago.
4+
5+
We can change that patch to produce traces suitable for the DB backend, or at least publish some kind of basis for that(the RR approach remains possible, but with different tradeoffs)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Noir
2+
3+
The initial release of CodeTracer has MVP support for the Noir programming language. It has been developed in collaboration with the Blocksense team and currently requires the use of the [Blocksense Noir Compiler](https://github.com/blocksense-network/noir), which is included in the CodeTracer distribution.
4+
5+
We support many of Noir's features, but not all: e.g. we don't support mutable references currently, we don't serialize struct values and some other cases.
6+
7+
We are planning on adding support for the missing features.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## python
2+
3+
We currently have started adding support for recording python programs for the DB backend, but the prototype isn't finished yet.
4+
5+
The recorder is currently hosted in the [codetracer-python-recorder](https://github.com/metacraft-labs/codetracer-python-recorder) repo.
6+
7+
You can read its README for more details. We are welcoming contributors!
8+
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Python

0 commit comments

Comments
 (0)