This folder explains how the Open Source Hub website is built and how to change it. It is written for anyone who has to maintain the site later, including people who did not build it. Start with the architecture page if you are new.
| Page | What it covers |
|---|---|
| Architecture | The parts of the site, what each one does, and why the site is built ahead of time instead of in the browser. |
| Data flow | Where the content comes from, how it is transformed, and where it ends up. |
| How to add a repository preview image | The three places a card image can come from, and the image sizes to use. |
| How to run the build locally | Running and testing the build on your own computer. |
| How to work on this site with an AI agent | A starting prompt for a new AI session, and the reasoning behind each part of it. |
| Troubleshooting | Known failures, what causes them, and how to fix them. |
| Compliance | Security and accessibility measures in place, and what still needs a human to check. |
Read the architecture page for the overall picture, then the how-to page that matches the change you need to make. If something is broken, start with troubleshooting.