refactor(docs): rename section index files to README.md#869
Open
refactor(docs): rename section index files to README.md#869
Conversation
Contributor
📚 Documentation Preview✅ Preview deployed successfully! 🔗 Preview URL: https://aws-games.github.io/cloud-game-development-toolkit/preview-pr-869/ 🔒 Maintainer Action RequiredThe preview requires approval before it's accessible. A maintainer must approve the GitHub Pages deployment in the Environments section. Once approved, the preview will be accessible within 1-2 minutes. Build Information
This preview will be automatically deleted when the PR is merged or closed. |
5 tasks
Rename documentation index files for consistency: - docs/assets/dockerfiles.md → docs/assets/docker/README.md - docs/assets/packer/index.md → docs/assets/packer/README.md - Update mkdocs.yml nav paths to match new locations
Update markdown links in docs/getting-started.md and docs/assets/index.md to reference the new file paths (packer/README.md, docker/README.md) instead of the old names (packer/index.md, dockerfiles.md).
hwkiem
force-pushed
the
refactor/docs-rename-section-indexes
branch
from
d425d3f to
b00e895
Compare
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/assets/dockerfiles.md→docs/assets/docker/README.mdfor consistency with thedocs/assets/packer/structuredocs/assets/packer/index.md→docs/assets/packer/README.mdto follow repo-wide conventionsmkdocs.ymlnav paths to match new file locationsContext
This is a housekeeping change to standardize documentation index file names. It prepares the
docs/assets/docker/directory to host per-image documentation alongside the overview page.Test plan
mkdocs serverenders the Assets section correctly