Codex Wiki OurBigBook logoOurBigBook.comSite Source code
AGENTS.md
# Agent guidelines

This repository contains a Codex-generated knowledge written in OurBigBook markup, created with a decent amount of human guidance.

First make sure to understand how OurBigBook Markup works and use its features nicely: https://docs.ourbigbook.com

This knowledge base aims to explain things very well and to make them very interesting for humans to read. It will be published on the web.

Some guidelines:

* interlink every scientific and mathematical subject that is mentioned HEAVILY. Interlink every time it appears in an article, not just the first one
* maintain nice concept hierarchies: e.g. mathematics > calculus > fundamental theorem of calculus (don't be afraid of arbitrarily deep nodes, if it makes sense, do it). Use pieces of knowledge as wide or granular as needed. If it is a concept, create a stub at least and interlink. 

## Exam solutions

One important activity done in this wiki is solving past undergraduate exams.

One example of this is past-exam-of-the-mathematics-course-of-the-university-of-cambridge.

There are two goals of this:

* to help future students study for future tests without reburning the tokens and the time
* to help populate our tree of important general knowledge

As such, when creating such solutions, interlink heavily as usual, and create at least stubs to every possibly reusable subject you come across. Do this even for things that seem simple like "eigenvalue". Especially for things which are not super well established, expand the stub so it will be clear what it is about. For super well established concepts, a shorter description is fine. We can expand those in a second pass when we are done solving a bunch of old exams.

## OurBigBook primer

There are a few important ourbigbook features which you must master and use well, notably for headers:

* `{c}` for capitalization. You want to set this for every header that has a fixed capitalization
* `{disambiguate}` when something might mean something else. Feel free then to `{synonym}` to something more specific that you are using often in our STEM heavy context for example
* `{synonym}` to create different names for the same thing, in particular ones that will allow you to seamlessly `<>` interlink from other places to a given concept
* `{wiki}` to point to wiki pages that already exist for concepts you come across

When in doubt, double check that the HTML output is awesome.

Newlines render as `<br>`, so don't indent code, keep long lines. You almost never want a newline, unless it is followed by a block construct. This is fine though:

```
My equation:
$$
1 + 1
$$
is nice
```

as it contains a block construct. It places the block construct inside the paragraph, which is fine because OurBigBook allows for strong nesting of many constructs in general (except headers which are mroe restricted).

## Mathematics guidelines

For mathematical concept headers which have a standard mathematical symbol, don't forget to title2 it.