Getting Started
Configuration Guide: Setting Up Your Environment
Now that your HouseLearning environment is running locally, itβs time to configure your workspace so you can contribute, customize, and build the docs efficiently.
1. Folder Structure Overview
HouseLearning uses a simple, GitHub Pagesβfriendly structure. Here's what each folder does:
π houselearning.github.io/ βββ π docs/ β All documentation files β βββ index.html β βββ helpcenter/ β βββ installation/ β βββ configuration/ βββ π assets/ β Images, icons, CSS overrides βββ index.html β Main homepage βββ 404.html β Error page
Keep everything clean and consistent so every page stays easy to find.
2. Editing Documentation Files
HouseLearning Docs uses pure HTML with Tailwind CSS. No build tools. No frameworks. Just edit and refresh. Hereβs how you do it:
- Open any file inside the
/docsfolder. - Make your changes in your editor.
- Refresh the browser β it updates instantly.
Donβt overcomplicate it. Keep it simple and clean.
3. Adding a New Documentation Page
Creating a new docs page is easy. Just follow these steps:
- Create a new folder in
/docs. - Add an
index.htmlfile inside it. - Copy an existing page layout to keep design consistency.
- Update the sidebar so the new page shows up in navigation.
Stick to the established structure so everything looks unified.
4. Deploying Changes
Since HouseLearning uses GitHub Pages, deployment is automatic:
- Commit your changes
- Push to the repository
- Wait 10β20 seconds for GitHub Pages to refresh
No extra build steps. No CI/CD config. It just works.
You're all set!
Next, explore the API Reference to understand how developers can integrate with HouseLearning.
Go to API Reference β