Welcome to the official documentation for HouseLearning — the platform packed with tools, guides, APIs, and developer resources that help you build, ship, and level up faster.
This repo gives you:
- 🔥 A clean docs UI
- 📘 Developer guides that actually make sense
- ⚙️ Config pages so you don’t get lost
- 💾 API references & data models
- 🛠 Troubleshooting that slaps
- 📡 Built-in feedback + cookie banners
- 📚 A simple, extensible file structure
Clone the repo and launch the docs locally:
git clone https://github.com/your/repo.git
cd docs
Preview the docs:
npx serve .
/docs
/getting-started
install.html
configuration.html
/api
reference.html
data-models.html
dev-guides.html
/troubleshooting
index.html
/assets
styles.css
script.js
/components
header.html
footer.html
docs.json
index.html
404.html
README.md
- Rounded corners, smooth shadows
- Mobile-responsive
- Light, clean, readable layout
Powered by a docs.json index:
- Instant results
- Title/description matching
- Clean dropdown UI
- API endpoints
- Data models
- Full dev guides
- Patterns + best practices
Quick fixes, error explanations, and “Still Stuck?” links baked into the flow.
<script src="/cookiebanner.js"></script>
<script src="https://houselearning.github.io/feedback.js"></script>
Pull requests? Yes.
New docs pages? Absolutely.
Random typo fixes? Please.
Just fork → edit → PR.
Open an issue or hit the feedback popup in the docs.
MIT — do your thing.
If you're building with HouseLearning, you’re already ahead of the curve.
These docs are crafted to stay clean, future-proof, and zero-BS.
Note: HouseLearning Docs is still a work in progress, so try not to report any issues if a link is broken or such - we know.