diff --git a/docs/01-introduction/01-overview.md b/docs/01-introduction/01-overview.md new file mode 100644 index 0000000..543c4c1 --- /dev/null +++ b/docs/01-introduction/01-overview.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 1 +slug: / +--- +# Overview + +Snigdha OS Developer Documentation (DevDocs) is your comprehensive guide to creating, customizing, and optimizing applications for the Snigdha OS ecosystem. Designed to empower developers at every stage, DevDocs combines powerful tools, clear guidance, and actionable insights to help you bring your innovative ideas to life. + +### Key Features and Details + +1. **Comprehensive Getting Started Guides** + - Step-by-step tutorials to set up your Snigdha OS development environment. + - Clear instructions for SDK installation and integration. + +2. **Extensive Framework and API Documentation** + - Deep dive into Snigdha OS’s core frameworks and APIs. + - Explore features like multi-threading, hardware integration, and AI/ML capabilities. + +3. **UI/UX Design Resources** + - Detailed design principles for creating consistent and user-friendly interfaces. + - Ready-to-use templates, themes, and style guides. + +4. **Development Tools and Resources** + - Access to IDE plugins, debugging tools, and performance profilers. + - Pre-built code snippets and fully functional sample projects to accelerate development. + +5. **Advanced Topics for Pro Developers** + - Tutorials on performance tuning, cross-platform compatibility, and security best practices. + - Insights into advanced features like IoT integration, voice commands, and more. + +6. **Robust Testing and Debugging Frameworks** + - Tools tailored to test Snigdha OS applications efficiently. + - Guidance for resolving issues and improving app stability. + +7. **Publishing and Distribution** + - Step-by-step guidance for submitting apps to the Snigdha App Store. + - Tips on app review compliance, distribution strategies, and user acquisition. + +### Why Choose Snigdha OS DevDocs? + +- **User-Centric Approach**: Snigdha OS is built with speed, reliability, and seamless user experiences in mind. +- **Innovative Tools**: Leverage cutting-edge tools and frameworks to build modern applications. +- **Community and Support**: Join a vibrant developer community and access dedicated support channels for assistance. + +Explore the resources, connect with other developers, and bring your creative vision to life with Snigdha OS Developer Documentation. Together, we’ll redefine what’s possible in application development. + diff --git a/docs/01-introduction/_category_.json b/docs/01-introduction/_category_.json index 318a5c6..b425fb2 100644 --- a/docs/01-introduction/_category_.json +++ b/docs/01-introduction/_category_.json @@ -3,6 +3,6 @@ "position": 1, "link": { "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." + "description": "An introductory guide to Snigdha OS Developer Docs, covering the basics to get you started quickly and effectively." } } diff --git a/docs/01-introduction/congratulations.md b/docs/01-introduction/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/docs/01-introduction/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/01-introduction/create-a-blog-post.md b/docs/01-introduction/create-a-blog-post.md deleted file mode 100644 index 550ae17..0000000 --- a/docs/01-introduction/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/01-introduction/create-a-document.md b/docs/01-introduction/create-a-document.md deleted file mode 100644 index c22fe29..0000000 --- a/docs/01-introduction/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/01-introduction/create-a-page.md b/docs/01-introduction/create-a-page.md deleted file mode 100644 index cccb76d..0000000 --- a/docs/01-introduction/create-a-page.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -sidebar_position: 1 -slug: / ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/docs/01-introduction/deploy-your-site.md b/docs/01-introduction/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/01-introduction/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/01-introduction/markdown-features.mdx b/docs/01-introduction/markdown-features.mdx deleted file mode 100644 index 35e0082..0000000 --- a/docs/01-introduction/markdown-features.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - -```md -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: -``` - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue !