Skip to content

docs: Mirai basic documentation #21

Merged
divyanshub024 merged 9 commits intodevfrom
dv/mirai-docs
Jan 3, 2025
Merged

docs: Mirai basic documentation #21
divyanshub024 merged 9 commits intodevfrom
dv/mirai-docs

Conversation

@divyanshub024
Copy link
Member

@divyanshub024 divyanshub024 commented Jan 3, 2025

Description

This PR introduces comprehensive documentation for Mirai, covering the following sections:

  1. Getting Started with Mirai: A step-by-step guide to help users begin their journey with Mirai.
  2. Why Mirai?: An overview of the benefits and unique features that set Mirai apart.
  3. Core Concepts: Detailed explanations of the fundamental principles underlying Mirai.
  4. Mirai Widget Parsers: Documentation on various widget parsers, currently focusing on the Container widget, with more to be added in future updates.

Note

Please note that the documentation for Mirai widget parsers is currently limited to the Container widget. Documentation for additional widgets will be added in separate, upcoming pull requests.

Related Issues

Issue #13

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Code refactor
  • Build configuration change
  • Documentation
  • Chore

@divyanshub024 divyanshub024 changed the title [Docs] docs: Mirai basic docs Jan 3, 2025
@divyanshub024 divyanshub024 changed the title docs: Mirai basic docs docs: Mirai basic documentation Jan 3, 2025
@divyanshub024 divyanshub024 merged commit 6a33189 into dev Jan 3, 2025
@divyanshub024 divyanshub024 deleted the dv/mirai-docs branch January 3, 2025 13:58
lstonussi pushed a commit to SuaMusica/stac that referenced this pull request Feb 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant