📘 TypeDoc API Documentation

This project generates API documentation from TypeScript files using TypeDoc and serves it using a Docusaurus website.

---

📦 About Documentation Source

• API documents are generated locally in this repository for the hosanna-ui repository project.
• This repository (hosanna-website) store all markdown files and static assets for the documentation website.

---

🛠️ Setup Instructions

1. Generate API Docs

⚠️ Warning:
Before you start generating docs, make sure that both hosanna-website and hosanna-ui are located in the same parent directory (as neighbors). This is required for the documentation generation process to work correctly.

Run the following command from the project root:

npm run docs
Copy

This will:

• Ensure the hosanna-ui version matches the hosanna-website version in their respective package.json files for consistency.
• Generate documentation from the shared files src/shared
• Output the docs to static/api

---

2. Run the Documentation Website

npm install
npm start
Copy

This will:

• Install required dependencies
• Start the development server

The site will open at the homepage by default.

---

🔗 Navigate to the Docs

In the website:

Tutorial → API Reference → Browse the generated API documentation
Copy

⚠️ Known Issue: You may see a "Page Not Found" error initially when navigating to the generated docs. Try refreshing the page — the docs should load correctly. (We're still investigating this 🫣)

//test 2