# FAC Curriculum

This repo contains the source code and content for our open-source curriculum: learn.foundersandcoders.com.

To learn more about the curriculum, including whether you're allowed to use it, please read the curriculum's [about page](https://learn.foundersandcoders.com/about/).

## Running locally

This site is built using the [Eleventy](https://11ty.dev/) static site generator. It requires Git, Node and npm installed on your machine to start.

1. Clone this repo
2. Run `npm install` to install all the required dependencies
3. Run `npm run dev` to start an auto-reloading development server

Alternatively run `npm run build` to create the final production `_site` directory. You can serve this with any web server as it's static HTML, CSS and JS.

### Git hooks

This package installs a custom pre-commit Git hook when you `npm install`. This hook automatically formats your changes using Prettier (with the default settings). This ensures all files have consistent style and formatting. So don't be surprised if you see things move around a bit after you commit a change.

[Remark](https://github.com/remarkjs/remark-lint) and [Alex](https://github.com/get-alex/alex) are set up to run on every commit. These will check for markdown formatting, and for inclusive language respectively. If ever you get stuck with a word not being accepted that should be, you can add the [rule](https://github.com/retextjs/retext-equality/blob/main/rules.md#list-of-rules) to the `.alexrc.js` file.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://founders-and-coders.gitbook.io/coursebook/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.