Skip to content

Add Astro Starlight documentation site with GitHub Pages deployment#233

Closed
rstrahan wants to merge 26 commits intomainfrom
feature/auto-starlight-docs
Closed

Add Astro Starlight documentation site with GitHub Pages deployment#233
rstrahan wants to merge 26 commits intomainfrom
feature/auto-starlight-docs

Conversation

@rstrahan
Copy link
Copy Markdown
Contributor

@rstrahan rstrahan commented Mar 9, 2026

Summary

Adds a hosted documentation site built with Astro Starlight, deployed to GitHub Pages at:
👉 https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws/

What's included

New: docs-site/ — Astro Starlight project

  • Zero content duplication — symlinks to existing docs/*.md files (no copy/paste)
  • Splash landing page with hero, feature cards, and quick navigation
  • Sidebar navigation organized into 11 categories matching docs/README.md
  • Full-text search via Pagefind (8,731 words indexed across 52 pages)
  • Dark/light mode toggle with AWS orange accent theme
  • GitHub Pages workflow (.github/workflows/deploy-docs.yml) auto-deploys on push to main

Modified: docs/*.md (52 files)

  • Added YAML frontmatter (title field) to all doc files
  • Backward-compatible — GitHub/GitLab markdown rendering handles frontmatter gracefully

Modified: README.md

  • Added 📖 documentation site link badge at top (next to DeepWiki)
  • Added callout in Detailed Documentation section

Modified: CHANGELOG.md

  • Added Documentation Site entry under [Unreleased] → Added

Modified: .gitignore

  • Added entries for docs-site build artifacts and symlinks

How it works

docs/*.md (existing) ──symlink──▶ docs-site/src/content/docs/
images/* (existing) ──symlink──▶ docs-site/public/images/
                                        │
                                   astro build
                                        │
                                        ▼
                                  Static HTML/CSS
                                        │
                                  GitHub Pages

Contributors still just edit markdown in docs/. The site rebuilds automatically.

Local development

cd docs-site
bash setup.sh     # creates symlinks
npm install
npm run dev       # http://localhost:4321

To redeploy manually

cd docs-site && npm run build && touch dist/.nojekyll && npx gh-pages -d dist -r github --dotfiles

Bob Strahan and others added 26 commits March 7, 2026 22:25
Bumps [immutable](https://github.com/immutable-js/immutable-js) and [@ardatan/relay-compiler](https://github.com/ardatan/graphql-tools). These dependencies needed to be updated together.

Updates `immutable` from 3.7.6 to 5.1.5
- [Release notes](https://github.com/immutable-js/immutable-js/releases)
- [Changelog](https://github.com/immutable-js/immutable-js/blob/main/CHANGELOG.md)
- [Commits](immutable-js/immutable-js@3.7.6...v5.1.5)

Updates `@ardatan/relay-compiler` from 12.0.3 to 12.3.0
- [Release notes](https://github.com/ardatan/graphql-tools/releases)
- [Commits](https://github.com/ardatan/graphql-tools/commits/@ardatan/relay-compiler@12.3.0)

---
updated-dependencies:
- dependency-name: immutable
  dependency-version: 5.1.5
  dependency-type: indirect
- dependency-name: "@ardatan/relay-compiler"
  dependency-version: 12.3.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Bob Strahan <strahanr@amazon.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) and [@aws-sdk/xml-builder](https://github.com/aws/aws-sdk-js-v3/tree/HEAD/packages-internal/xml-builder). These dependencies needed to be updated together.

Updates `fast-xml-parser` from 5.3.6 to 5.4.1
- [Release notes](https://github.com/NaturalIntelligence/fast-xml-parser/releases)
- [Changelog](https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/CHANGELOG.md)
- [Commits](NaturalIntelligence/fast-xml-parser@v5.3.6...v5.4.1)

Updates `@aws-sdk/xml-builder` from 3.972.5 to 3.972.10
- [Release notes](https://github.com/aws/aws-sdk-js-v3/releases)
- [Changelog](https://github.com/aws/aws-sdk-js-v3/blob/main/packages-internal/xml-builder/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js-v3/commits/HEAD/packages-internal/xml-builder)

---
updated-dependencies:
- dependency-name: fast-xml-parser
  dependency-version: 5.4.1
  dependency-type: indirect
- dependency-name: "@aws-sdk/xml-builder"
  dependency-version: 3.972.10
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Bob Strahan <strahanr@amazon.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [dompurify](https://github.com/cure53/DOMPurify) from 3.3.1 to 3.3.2.
- [Release notes](https://github.com/cure53/DOMPurify/releases)
- [Commits](cure53/DOMPurify@3.3.1...3.3.2)

---
updated-dependencies:
- dependency-name: dompurify
  dependency-version: 3.3.2
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Bob Strahan <strahanr@amazon.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Removed Bedrock Data Automation (BDA) Project ARN CloudFormation parameter

See merge request genaiic-reusable-assets/engagement-artifacts/genaiic-idp-accelerator!568
Sync to BDA no longer auto-activates the config version

See merge request genaiic-reusable-assets/engagement-artifacts/genaiic-idp-accelerator!569
Discovery no longer injects default config classes into target version

See merge request genaiic-reusable-assets/engagement-artifacts/genaiic-idp-accelerator!570
* > Add discovery CLI command and SDK operations for automated schema generation

* > Add discovery SDK/CLI with local and stack-connected modes, remove S3 upload dependency

* > docs: add discovery CLI command and SDK operations documentation

* > Add Discovery module documentation to README files

* > Add batch ground truth matching and flexible output modes to discovery CLI

* > Add stdout output for discover command in batch mode when no output file specified

---------

Co-authored-by: Bob Strahan <strahans@amazon.com>
…ve all strict-mode errors (#226)

* chore(ui): add @types packages and properly type context interfaces

- Install @types/react-syntax-highlighter and @types/js-yaml
- Replace catch-all [key: string]: unknown with explicit typed fields
  in app, documents, and settings contexts
- Make context hooks throw on null (removing need for ! assertions)
- Fix all consumer files: remove as casts, ! assertions, || {} fallbacks
- Move AppActiveTestRun interface to context file
- Type GenAIIDPLayout selectedItems as Document[]

* chore(ui): fix noImplicitAny errors and enable flag

* chore(ui): fix strictNullChecks errors and enable flag

* chore(ui): enable remaining strict sub-flags

* chore(ui): enable strict: true and remove allowJs

* fix(ui): use || instead of ?? for hitlReviewOwner fallback consistency

* refactor(ui): add DocumentClass/pageCount to Document type and remove 4 double-casts

* refactor(ui): replace dynamic field assignment casts with object spread

* refactor(ui): type allSections prop properly and remove 3 double-casts

* refactor(ui): add configVersion to StartTestRun mutation and remove double-cast

* refactor(ui): replace explicit any types with proper types where safe

* fix(ui): remove index signature from allSections prop type for SectionItem compatibility

* refactor(ui): extract shared getErrorMessage utility, fix cost row types, and fix indentation

---------

Co-authored-by: Aditya Addepalli <adiadd@amazon.com>
…, frontmatter to all docs, and gitignore for build artifacts
@rstrahan
Copy link
Copy Markdown
Contributor Author

rstrahan commented Mar 9, 2026

Closing to retarget to develop branch

@rstrahan rstrahan closed this Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants