Skip to content

Move the Vacation Planner introduction into the Samples section - #24

Merged
paolosalvatori merged 2 commits into
mainfrom
readme-structure
Aug 6, 2026
Merged

Move the Vacation Planner introduction into the Samples section#24
paolosalvatori merged 2 commits into
mainfrom
readme-structure

Conversation

@paolosalvatori

Copy link
Copy Markdown
Collaborator

Motivation

The README opened with the Vacation Planner app: a paragraph about it, the list of data services the samples vary, and a screenshot of its UI. That describes the samples, not the repository. With thirteen tutorials now in tutorials/ that never deploy that app, the first thing a reader saw was the narrower half of the content, and the screenshot set the expectation that the whole repository is one web app in eight flavours.

Changes

The introduction is now about the repository and points at its two kinds of content, samples and tutorials, each linking to its section.

Everything specific to the Vacation Planner moved to the top of the Samples section, immediately above the sample table it describes: the app description, the list of backing data services, and the screenshot. One sentence was added there to say why the app is deliberately identical across samples, which is what makes them comparable.

No content was removed, and no other section changed.

Testing

Documentation only. The two new in-page links (#samples, #tutorials) resolve to the existing headings, and the image path is unchanged.

The repository opened with the Vacation Planner app, its list of backing data services and a screenshot of its UI, which described the samples rather than the repository: it now also holds thirteen tutorials that never deploy that app at all, so the first thing a reader saw was the narrower half of the content.

The introduction is now about the repository, and points at its two kinds of content. Everything specific to the Vacation Planner, the description, the data-service list and the screenshot, moved down to the top of the Samples section, where the sample table it belongs to already lives. No content was dropped.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 6, 2026 11:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR reorganizes the README introduction to describe the repository at a higher level and relocates the Vacation Planner–specific description to the Samples section where it best contextualizes the sample table.

Changes:

  • Rewrote the README opening to describe the repo’s purpose and link readers to the two content types: Samples and Tutorials.
  • Moved the Vacation Planner description, backing data-service list, and screenshot to the top of the Samples section, adding a sentence explaining why the app is kept identical across samples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

The list named the eight services the sample table below already names, with links and more detail (the in-cluster PostgreSQL row even describes its streaming replicas), so it was pure duplication once the section moved down here.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@paolosalvatori
paolosalvatori merged commit 938d338 into main Aug 6, 2026
1 check passed
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