Skip to content

MindReset/dot_web_docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

123 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dot. Documentation

Languages: English | 简体中文 | 日本語

License

Welcome to the official documentation repository for Dot. products! This repository contains comprehensive user manuals, API documentation, FAQs, and security advisories for the Dot. App and Dot. series devices.

📚 About This Repository

This is the documentation center for MindReset's Dot. brand, including:

  • Product Manuals: Detailed installation, configuration, and usage guides
  • Device Documentation: Complete operation instructions for Quote/0 and other devices
  • Developer Documentation: Open API and Studio integration guides
  • FAQs: Troubleshooting and problem-solving solutions
  • Security Advisories: Product security updates and vulnerability disclosures
  • Firmware Changelogs: Version history and update notes

🌍 Multi-language Support

Documentation is available in the following languages:

  • 简体中文 (zh-Hans-CN/)
  • English (en-US/)
  • 日本語 (ja-JP/)

📖 Documentation Structure

dot_web_docs/
├── zh-Hans-CN/          # Simplified Chinese documentation
├── en-US/               # English documentation
└── ja-JP/               # Japanese documentation
    ├── index.mdx        # Documentation homepage
    ├── about_mindreset.mdx
    ├── contact.mdx
    ├── privacy.mdx
    ├── terms.mdx
    ├── dot/             # Dot. App related documentation
    ├── quote_0/         # Quote/0 device documentation
    │   ├── start/       # Quick start guides
    │   ├── faq/         # Frequently asked questions
    │   └── firmware/    # Firmware updates
    ├── security_advisory/  # Security advisories
    └── service/         # Service & API documentation
        ├── open/        # Open API
        ├── studio/      # Studio creation platform
        └── co_create/   # Co-creation program

🤝 Contributing

We welcome and encourage community contributions to improve the documentation! If you find any errors, omissions, or want to improve the content, please participate through:

Submit Issues

If you find problems in the documentation or have suggestions for improvement, please create an Issue.

Submit Pull Requests

  1. Fork this repository
  2. Create your feature branch (git checkout -b feature/improve-docs)
  3. Commit your changes (git commit -m 'docs: update Quote/0 pairing instructions')
  4. Push to the branch (git push origin feature/improve-docs)
  5. Create a Pull Request

Contribution Guidelines

Before submitting content, please note:

  • Maintain Consistency: Follow the existing documentation format and style
  • Accuracy: Ensure technical information is accurate
  • Multi-language: If possible, please update all language versions simultaneously
  • Clear Expression: Use concise and understandable language
  • Image Optimization: If adding images, ensure file sizes are reasonable

💡 Technology Stack

This documentation is built with:

  • Fumadocs - Documentation framework
  • MDX - Markdown extended syntax
  • Next.js - React framework

📄 License

This documentation is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

This means you can:

  • Share — Copy and redistribute the material in any medium or format
  • Adapt — Remix, transform, and build upon the material

Under the following terms:

  • Attribution — You must give appropriate credit
  • NonCommercial — You may not use the material for commercial purposes
  • ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license

📮 Contact Us

For any questions or suggestions, please contact us through:

🔗 Related Links


Maintained with ❤️ by MindReset

About

Dot Web Docs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages