Parent PRD
What to build
Remove the old docs/ directory (now that all content lives in packages/docs/) and update the root README to point to the deployed documentation site.
End-to-end, this means:
- Delete the
docs/ directory and all its contents
- Create a new
docs/README.md with a single redirect message pointing to https://aws.github.io/graph-explorer/ and a note that source lives in packages/docs/
- Update root
README.md links:
./docs/getting-started/README.md → https://aws.github.io/graph-explorer/getting-started/
./docs/guides → https://aws.github.io/graph-explorer/guides/
./docs/development.md → https://aws.github.io/graph-explorer/references/development/
./docs → https://aws.github.io/graph-explorer/
- Leave root
README.md images and images/ directory untouched
Acceptance criteria
Blocked by
User stories addressed
- User story 8 (canonical documentation URL)
Parent PRD
What to build
Remove the old
docs/directory (now that all content lives inpackages/docs/) and update the root README to point to the deployed documentation site.End-to-end, this means:
docs/directory and all its contentsdocs/README.mdwith a single redirect message pointing tohttps://aws.github.io/graph-explorer/and a note that source lives inpackages/docs/README.mdlinks:./docs/getting-started/README.md→https://aws.github.io/graph-explorer/getting-started/./docs/guides→https://aws.github.io/graph-explorer/guides/./docs/development.md→https://aws.github.io/graph-explorer/references/development/./docs→https://aws.github.io/graph-explorer/README.mdimages andimages/directory untouchedAcceptance criteria
docs/directory is removed (except for the new redirect README)docs/README.mdpoints users to the deployed site and source locationREADME.mdlinks point tohttps://aws.github.io/graph-explorer/URLsREADME.mdimages still render correctly on GitHubBlocked by
User stories addressed