Restructure and update documentation#46
Merged
Merged
Conversation
armalikhani
force-pushed
the
feat/aa/restructure-docs
branch
2 times, most recently
from
1603b29 to
a2455c9
Compare
- Organize docs folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (index.md) - Move previous README content to getting_started.md - Add initial architecture overview documentation
armalikhani
force-pushed
the
feat/aa/restructure-docs
branch
from
a2455c9 to
7c8573f
Compare
armalikhani
added a commit
that referenced
this pull request
Jun 10, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
armalikhani
added a commit
that referenced
this pull request
Jun 10, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
armalikhani
added a commit
that referenced
this pull request
Jun 10, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
armalikhani
added a commit
that referenced
this pull request
Jun 10, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
armalikhani
added a commit
that referenced
this pull request
Jun 10, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
armalikhani
added a commit
that referenced
this pull request
Jun 11, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
armalikhani
added a commit
that referenced
this pull request
Jun 11, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
armalikhani
added a commit
that referenced
this pull request
Jun 11, 2026
- Organize documentation folder layout - Add standard README.md aligned with MQSS repositories - Add minimal GitHub Pages landing page (docs/index.md) - Move existing README content to user guide (docs/user_guide/getting_started.md) - Add initial architecture overview documentation (docs/development_guide/architecture_overview.md) - Add contributing guide page linking to root CONTRIBUTING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR restructures the documentation and improves the overall docs organization.
Key changes