Skip to content

Clean up old docs directory and update README links #1758

@kmcginnes

Description

@kmcginnes

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:

  1. Delete the docs/ directory and all its contents
  2. 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/
  3. Update root README.md links:
    • ./docs/getting-started/README.mdhttps://aws.github.io/graph-explorer/getting-started/
    • ./docs/guideshttps://aws.github.io/graph-explorer/guides/
    • ./docs/development.mdhttps://aws.github.io/graph-explorer/references/development/
    • ./docshttps://aws.github.io/graph-explorer/
  4. Leave root README.md images and images/ directory untouched

Acceptance criteria

  • Old docs/ directory is removed (except for the new redirect README)
  • docs/README.md points users to the deployed site and source location
  • Root README.md links point to https://aws.github.io/graph-explorer/ URLs
  • Root README.md images still render correctly on GitHub
  • No broken links remain in the root README

Blocked by

User stories addressed

  • User story 8 (canonical documentation URL)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions