HouseLearning Docs

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 /docs folder.
  • 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:

  1. Create a new folder in /docs.
  2. Add an index.html file inside it.
  3. Copy an existing page layout to keep design consistency.
  4. 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 β†’