Skip to content

v2 Getting Started (AWS)#606

Open
remotesynth wants to merge 39 commits into
mainfrom
revise-getting-started
Open

v2 Getting Started (AWS)#606
remotesynth wants to merge 39 commits into
mainfrom
revise-getting-started

Conversation

@remotesynth
Copy link
Copy Markdown
Collaborator

@remotesynth remotesynth commented Apr 24, 2026

This PR is still in early draft form.

The concepts behind this draft:

  1. Design paths for the main LocalStack use cases
  2. Simplify the quickstart to get them to success faster
  3. Have both an awslocal and a terraform quickstart
  4. Bring AI and agent use cases up front

DOC-12

The concepts behind this draft:

1. Design paths for the main LocalStack use cases
2. Simplify the quickstart to get them to success faster
3. Have both an awslocal and a terraform quickstart
4. Bring AI and agent use cases up front

[DOC-12](https://linear.app/localstack/issue/DOC-12/docs-quickstart-v2)
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 24, 2026

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 60eed52
Status: ✅  Deploy successful!
Preview URL: https://6ca545f7.localstack-docs.pages.dev
Branch Preview URL: https://revise-getting-started.localstack-docs.pages.dev

View logs

@quetzalliwrites quetzalliwrites marked this pull request as draft April 27, 2026 12:17
@quetzalliwrites
Copy link
Copy Markdown
Collaborator

added do not merge label + made it a draft to avoid any accidental merges @remotesynth 😸

Copy link
Copy Markdown
Contributor

@peter-smith-phd peter-smith-phd left a comment

Choose a reason for hiding this comment

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

Thanks for sharing this PR. It's really nice to see the focus of Local, CI, and AI, and the working example is the perfect size to get something up and running in 10 minutes.

But, I think there's more trimming to be done. There's still a lot of complexity in these pages that go beyond "Getting Started". It'd suggest you document the happy path for the common case, and just hyperlink to the more advanced pages for more detail. If we can't get the happy path working well, then we need to fix the software to make it work better.

Comment thread src/content/docs/aws/getting-started/index.mdx Outdated
Comment thread src/content/docs/aws/getting-started/index.mdx Outdated
Comment thread src/content/docs/aws/getting-started/installation.mdx Outdated
Comment thread src/content/docs/aws/getting-started/installation.mdx Outdated
Comment thread src/content/docs/aws/getting-started/installation.mdx Outdated
Comment thread src/content/docs/aws/getting-started/ci-cd.mdx Outdated
Comment thread src/content/docs/aws/getting-started/ai-workflows.mdx Outdated
Comment thread src/content/docs/aws/getting-started/index.mdx
Comment thread src/content/docs/aws/getting-started/auth-token.mdx Outdated
Comment thread src/content/docs/aws/getting-started/faq.mdx
Comment thread src/content/docs/aws/getting-started/index.mdx Outdated
Comment thread src/content/docs/aws/getting-started/index.mdx Outdated
@quetzalliwrites
Copy link
Copy Markdown
Collaborator

PR Audit Summary

Status: Needs Significant Rework

This PR introduces several critical technical inaccuracies, broken code snippets, and information architectural redundancies. To maintain our technical integrity and avoid introducing "docs debt," the following must be addressed before merging.

Technical & Architectural Requirements

1) Technical Accuracy (High Priority)

2) Code Integrity (Blockers):

All code blocks must be validated and "copy-paste ready" before deployment.

3) Documentation Information Architecture (DRY Principles):

4) Editorial Standards:

  • Voice & Tone: The current draft uses informal, "blog-style" phrasing (e.g., "That's the win"). We are reverting this to a proffesional, technical documentation voice to maintain authority.

  • Punctuation: Consistent with our style guide, we are replacing the over use of em-dashes with colons or period breaks to remove AI-generated markers + improve readability.

Screenshot 2026-05-26 at 9 38 54 PM

Why this is necessary:

We are holding this PR to ensure the "Getting Started" experience (the most high-traffic area of our site) is technically accurate and the information architecture is consistent. Merging in the current state would introduce immediate technical debt and user friction.

@quetzalliwrites
Copy link
Copy Markdown
Collaborator

Information Architecture Realignment: Removing Quickstart Anti-Pattern

As part of the v2 Getting Started experience, I am realigning our information architecture (and sidebar hierarchy) to resolve a long-standing architectural anti-pattern: housing a specific Quickstart tutorial within the general "Getting Started" folder.

Rationale for the Restructure:

  • Eliminating Cognitive Load: Titling a page "Local Development" while the internal content refers to it as a "Quickstart" creates a significant disconnect for the user. Users expect "Local Development" to cover core operational concepts (persistence, networking, dev loops); finding a specific Lambda/DynamoDB tutorial instead is a misleading user experience.

  • Getting Started as a Journey: Industry standard dictates that "Getting Started" is a high-level journey. Covering the Overview, Installation, and initial Configuration. It is the foundation, not the specific implementation.

  • Decoupling Content Types: A Quickstart is a specific functional recipe, whereas Getting Started is system onboarding. To scale effectively, we must decouple these. This realignment is the first step toward our Quickstart Library (currently tracked in this Linear DOCS Project), mirroring the successful developer experiences of enterprise leaders like Stripe and HashiCorp.

Action Taken: I am stripping the "Quickstart" branding from the "Local Development" page and reframing it as a declarative guide for deploying your first local serverless API. This ensures the folder remains a cohesive onboarding path, while the upcoming Quickstart Library will serve as the dedicated home for specialized, multi-language recipes.

@quetzalliwrites quetzalliwrites changed the title Initial draft for revising getting started v2 Getting Started (AWS) May 28, 2026
The reference to the k8 tutorial has been moved into a standard Note component. This file is now dead code.
Removed redundant "Next Steps" clutter and relocated Docker, Compose, and Helm to a dedicated orchestration section. Standardized tone and corrected tool categorizations.
Consolidated use cases, removed duplicated MCP configuration, and deleted non-functional validation content. Standardized the tone and improved technical context throughout the guide.
Comment thread src/content/docs/aws/getting-started/ci-cd.mdx Outdated
@localstack localstack deleted a comment from HarshCasper Jun 2, 2026
Comment thread src/content/docs/aws/getting-started/local-development.mdx
Comment thread src/content/docs/aws/getting-started/local-development.mdx Outdated
Comment thread src/content/docs/aws/getting-started/installation.mdx
Comment thread src/content/docs/aws/getting-started/ci-cd.mdx Outdated
Comment thread src/content/docs/aws/getting-started/auth-token.mdx Outdated
Comment thread src/content/docs/aws/getting-started/ai-workflows.mdx Outdated
Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com>
Co-authored-by: Quetzalli  <alejandra.olvera.novack@gmail.com>
@quetzalliwrites
Copy link
Copy Markdown
Collaborator

note: We must add to our docs agent a linter check for validating against AI code snippet indentation mistakes.

This PR had indentation mistakes in 2 files, python and yaml. This is a AI mistake we should watch for.

@HarshCasper HarshCasper marked this pull request as ready for review June 4, 2026 05:31
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.

5 participants