{"id":39027860,"url":"https://github.com/jupyter-naas/docs","last_synced_at":"2026-01-17T17:34:29.660Z","repository":{"id":159849791,"uuid":"617017438","full_name":"jupyter-naas/docs","owner":"jupyter-naas","description":"Documentation for building AI Networks as a Service with the Naas platform.","archived":false,"fork":false,"pushed_at":"2025-09-01T23:32:46.000Z","size":164133,"stargazers_count":7,"open_issues_count":0,"forks_count":4,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-09-02T01:17:31.142Z","etag":null,"topics":["ai","analytics","automation","blog","data","website"],"latest_commit_sha":null,"homepage":"https://docs.naas.ai","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jupyter-naas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-03-21T14:38:52.000Z","updated_at":"2025-09-01T23:32:49.000Z","dependencies_parsed_at":"2025-08-15T23:22:47.765Z","dependency_job_id":null,"html_url":"https://github.com/jupyter-naas/docs","commit_stats":null,"previous_names":["jupyter-naas/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jupyter-naas/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-naas%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-naas%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-naas%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-naas%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jupyter-naas","download_url":"https://codeload.github.com/jupyter-naas/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-naas%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28513324,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T13:38:16.342Z","status":"ssl_error","status_checked_at":"2026-01-17T13:37:44.060Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","analytics","automation","blog","data","website"],"created_at":"2026-01-17T17:34:29.149Z","updated_at":"2026-01-17T17:34:29.646Z","avatar_url":"https://github.com/jupyter-naas.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Naas Documentation\n\nUniversal Data \u0026 AI Platform for building AI assistants and automating business workflows.\n\n[![Node.js](https://img.shields.io/badge/Node.js-\u003e=20.0-green.svg)](https://nodejs.org/)\n[![Docusaurus](https://img.shields.io/badge/Docusaurus-3.6.3-blue.svg)](https://docusaurus.io/)\n[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\n**🚀 [Live Documentation](https://docs.naas.ai)** | **🔧 [API Docs](https://api.naas.ai/redoc)** | **💬 [Community](https://join.slack.com/t/naas-club/shared_invite/zt-1970s5rie-dXXkigAdEJYc~LPdQIEaLA)**\n\n## Table of Contents\n\n- [Naas Documentation](#naas-documentation)\n  - [Table of Contents](#table-of-contents)\n  - [Overview](#overview)\n  - [Quick Start](#quick-start)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n  - [Development](#development)\n    - [Building for Production](#building-for-production)\n    - [Testing the Build](#testing-the-build)\n  - [Project Structure](#project-structure)\n    - [Key Directories](#key-directories)\n  - [Available Scripts](#available-scripts)\n  - [Docker Setup (Optional)](#docker-setup-optional)\n  - [Contributing](#contributing)\n    - [Making Changes](#making-changes)\n    - [Writing Guidelines](#writing-guidelines)\n    - [File Organization](#file-organization)\n  - [Support](#support)\n\n## Overview\n\nThis repository contains the official documentation for Naas (AI Networks as a Service), a comprehensive platform that enables teams to build AI assistants, automate business workflows, and create data-driven applications.\n\n## Quick Start\n\n### Prerequisites\n\n- **Node.js** \u003e= 20.0\n- **npm** or **yarn**\n- **Docker** (optional, for containerized development across multiple codebases)\n\n\n### Installation\n\n1. **Clone the repository**\n   ```bash\n   git clone https://github.com/jupyter-naas/docs.git\n   cd docs\n   ```\n\n2. **Install dependencies**\n   ```bash\n   cd site\n   npm install\n   ```\n\n3. **Start development server** (from the `site/` directory)\n   ```bash\n   cd site\n   npm run start\n   ```\n\n4. **Open your browser**\n   \n   [http://localhost:3000](http://localhost:3000)\n\nThe site will automatically reload when you make changes to the documentation files.\n\n## Development\n\nThe development server from the installation steps above provides hot reloading - changes are reflected live without restarting the server.\n\n### Building for Production\n\n```bash\ncd site\nnpm run build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n### Testing the Build\n\n```bash\ncd site\nnpm run serve\n```\n\nServes the production build locally for testing purposes.\n\n## Project Structure\n\nThis documentation site is built with Docusaurus. The blog functionality exists but is currently hidden from the UI.\n\n```\ndocs/\n├── site/                   # Docusaurus application\n│   ├── docs/              # Documentation content\n│   │   ├── get-started/   # Getting started guides\n│   │   ├── customize/     # Customization docs\n│   │   └── scale/         # Scaling and API docs\n│   ├── blog/              # Blog content (not yet active in UI)\n│   ├── src/               # Custom React components\n│   └── static/            # Static assets\n├── docker-compose.yaml    # Docker configuration for workspace\n└── README.md             # This file\n```\n\n### Key Directories\n\n- **`site/docs/`** - Main documentation content in Markdown\n- **`site/blog/`** - Blog content (hidden in UI, planned for future activation)\n- **`site/src/`** - Custom React components and pages\n- **`site/static/`** - Images, assets, and downloadable files\n- **`site/docusaurus.config.js`** - Docusaurus configuration\n\n## Available Scripts\n\n| Command | Description |\n|---------|-------------|\n| `npm run start` | Start development server |\n| `npm run build` | Build for production |\n| `npm run serve` | Serve production build locally |\n| `npm run clear` | Clear Docusaurus cache |\n| `npm run swizzle` | Customize Docusaurus components |\n| `npm run deploy` | Deploy to GitHub Pages |\n\n## Docker Setup (Optional)\n\nFor teams working across multiple codebases in this workspace, Docker provides environment consistency:\n\n```bash\n# Start documentation site in container\ndocker-compose up docusaurus\n\n# Access at http://localhost:3003\n```\n\nThe Docker setup is particularly useful when:\n- Working across multiple codebases with different runtime requirements\n- Onboarding new team members\n- Ensuring consistent environments across development machines\n\n## Contributing\n\nWe welcome contributions to improve the documentation!\n\n### Making Changes\n\n1. **Fork the repository**\n2. **Create a feature branch**\n   ```bash\n   git checkout -b feature/improve-docs\n   ```\n3. **Make your changes**\n4. **Test locally**\n   ```bash\n   npm run start -- --port 3003\n   ```\n5. **Submit a pull request**\n\n### Writing Guidelines\n\n- Use clear, concise language\n- Include code examples where applicable\n- Follow the existing structure and formatting\n- Test all links and references\n- Optimize images for web delivery\n\n### File Organization\n\n- Place new documentation in the appropriate `docs/` subdirectory\n- Use descriptive filenames with hyphens (e.g., `api-integration.md`)\n- Update navigation in `sidebars.js` when adding new sections\n\n## Support\n\n- **Documentation**: [docs.naas.ai](https://docs.naas.ai)\n- **API Reference**: [api.naas.ai/redoc](https://api.naas.ai/redoc)\n- **Community Slack**: [Join Here](https://join.slack.com/t/naas-club/shared_invite/zt-1970s5rie-dXXkigAdEJYc~LPdQIEaLA)\n- **GitHub Issues**: [Report bugs or request features](https://github.com/jupyter-naas/docs/issues)\n\n---\n\n**Built with ❤️ using [Docusaurus](https://docusaurus.io/)**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyter-naas%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjupyter-naas%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyter-naas%2Fdocs/lists"}