docs: move documentation to docs branch#37
Merged
KerwinTsaiii merged 3 commits intodevelopfrom Mar 5, 2026
Merged
Conversation
Remove docs/ directory (all content synced to docs branch Sphinx site). Update README.md, CONTRIBUTING.md, and deploy/README.md to point to the hosted documentation site instead of local docs/ files. - Delete docs/ directory (5 markdown, 18 images, 1 PDF) - Update README.md: link to docs site, add PhySim course, fix image table - Fix CONTRIBUTING.md: correct repo URL, update frontend paths - Fix deploy/README.md: replace broken doc links with docs site URLs
The overview.png is the hardware rack diagram, not the software architecture diagram. Copy the original software-stack.png to deploy/docs/images/ and reference it in README.md.
Replace verbose deploy/ markdown files with concise quick-reference versions that link to the full documentation site. Detailed content has been moved to the docs branch Sphinx site.
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
2 participants
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.
Summary
docs/directory fromdevelop— all content has been synced to thedocsbranch (Sphinx site, PR docs: sync Sphinx site with develop and fix outdated content #36)README.md: replacedocs/links with hosted documentation site URLs, add PhySim course, update image tableCONTRIBUTING.md: correct repo URL (aup-learning-cloud-dev→aup-learning-cloud), update frontend paths (runtime/admin/frontend/admin-frontend→runtime/hub/frontend)deploy/README.md: replace broken doc links (../docs/user-manual/aup-remote-lab-user-manual-admin-new.md,../docs/jupyterhub/README.md) with docs site URLsFiles removed (24 files)
docs/jupyterhub/— 5 markdown files (README, authentication-guide, user-management, quota-system, How_to_Setup_GitHub_OAuth)docs/imgs/— 18 images (github-1..13.png, quota screenshots, software-stack.png)docs/user-manual/— 1 PDF (admin manual)Files updated (3 files)
README.md— Documentation section now points to https://amdresearch.github.io/aup-learning-cloud/CONTRIBUTING.md— Fixed repo URL and frontend pathsdeploy/README.md— Fixed 2 broken doc linksTest plan
docs/paths