Contributing

gitfork · branch · pull request

Contributions are welcome. Skills are edited in agent/skills/, never inside an agent's own folder. File formats live in one place, agent/reference/formats.md: a change to a format goes there and to topics/example/.

shell

git checkout -b my-change
# edit agent/skills/... or app/...
uv run python app/tests/run.py
git push origin my-change

app/server/: server.py (HTTP and the slp commands), store.py (every file read and write), voice.py (dictation), text.py (Markdown ⇄ HTML)
app/views/: one HTML page per view. Design reference: app/styles/Design.md
tests: plain scripts in app/tests/, no framework. One runs with uv run python app/tests/test_<name>.py and prints ok; run.py runs them all

For bugs or ideas, open an issue. Licensed MIT.

Thanks to amosblomqvist/learn for the method behind slp-teach and to Matt Pocock for per-topic memory and spaced review.

roadmap →

Markdown formats

The documentation is also available in llms.txt formats:

llms.txt lists every documentation page.
llms-full.txt contains the complete documentation in one file and may exceed some context windows.

Append .md to any documentation URL to retrieve that page as Markdown. For example, this page is available at https://selflearningplatform.github.io/docs/contributing.md. You can also copy the current page as Markdown by pressing Cmd+C or Ctrl+C.