Welcome to the Deal Knowledge Base

Welcome to the central knowledge base for the Dhiraagu Data Science & Data Engineering team. This platform allows us to document our code, workflows, and architecture in a version-controlled environment.

⚙️ Why Documentation as Code?

We adopted this approach to ensure our documentation is:

1. Versioned: Like our code, we can see history and blame.
2. Reviewable: Changes go through Pull Requests.
3. Automated: Deploys automatically via Cloudflare Pages.

🏗 Project Structure

An overview of the essential files and directories in this repository:

File / Folder	Purpose
docs/	Primary Content. Contains all technical documentation. Folders like Huawei CBS/ and DEAL ETL Logic/ represent distinct knowledge domains.
blog/	Morning Reading Group. A feed-style section for team updates, readings, and logs. Files must be named YYYY-MM-DD-title.md.
docusaurus.config.js	Site Configuration. The central hub for site metadata, URL settings, navbar links, and theme configurations.
sidebars.js	Navigation Logic. Defines the structure of the left-hand sidebar. Currently set to autogenerated to mirror the folder structure.
src/css/custom.css	Styles. Custom CSS overrides to maintain a clean, professional "Microsoft Docs" aesthetic.
static/	Assets. Stores non-markdown files like images, diagrams, and logos. Reference these in docs using absolute paths (e.g., /img/diagram.png).
package.json	Dependencies. Lists the Node.js packages required to build and run the site.

🚀 Workflow: Documentation as Code

We follow a standard Git workflow to manage our knowledge base.

1. Draft: Create or edit a .md file in the docs/ or blog/ folder.
2. Preview (Local): Run npm start to view changes locally at http://localhost:3000.
3. Commit: Save your changes: git commit -am "Added ETL logic for subscriber status".
4. Push: git push origin main.
5. Deploy: Cloudflare Pages automatically detects the push, builds the site, and deploys it to the production URL within minutes.

🛠 Maintenance Tips

Adding New Categories

To add a new folder to the sidebar (e.g., ML Models), create the folder and add a _category_.json file inside it:

{
  "label": "Machine Learning Models",
  "position": 4,
  "link": {
    "type": "generated-index"
  }
}

Work in Progress

This site is currently under active development. If you find an error, please click "Edit this page" below.