docs: present emulators side by side instead of naming a default - #168
Merged
Merged
Conversation
StackPort is emulator-neutral, and the docs should read that way. - Quick Start shows MiniStack and Floci next to each other, no "recommended" pick - root docker-compose.yml goes back to MiniStack; the seeded Floci example stays in examples/docker-compose.floci.yml - Compose sections in the README list MiniStack first, then Floci - add an Origin section crediting the MiniStack PR the project grew out of - emulator lists across CLAUDE.md, CONTRIBUTING, the bug template, the Docker Hub description, the VS Code extension and pyproject follow the same order
- the MiniStack Compose example gets the same one-shot seed as the Floci one, so both dashboards come up populated - README Quick Start shows `docker run` for both emulators; the two Compose examples share one intro and have the same structure, each with its own one-line note on how URLs resolve - CONTRIBUTING gains an "Emulator neutrality" section: same depth for every supported emulator, one fixed list order, root compose is a historical example and not a recommendation, PRs that tilt the docs toward one emulator are closed with a link to the policy - CLAUDE.md points at the policy
"Supported emulators" is a heading any project would have. The rule is unchanged: same depth for every emulator, one fixed order, root compose is a historical example, and changes that make one emulator stand out are declined with a pointer to the section.
This was referenced Sep 20, 2026
Closed
Owner
Author
|
Heads-up @hectorvent, since this touches your example from #161: I am moving the docs to present emulators side by side instead of naming a default, and writing that down in CONTRIBUTING. Your Compose example stays as is and keeps its section. The MiniStack example gets the same seed, so the two are at parity. Thanks again for the contribution, the seed script turned out to be useful for both. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #161, #166 and #167.
StackPort works against any AWS-compatible emulator, and the docs should read that way rather than naming one as the default. This PR writes that down and brings the two documented emulators to parity.
Parity
docker runlines, with no "recommended" pickdocker-compose.ymlgoes back to MiniStack. The Floci example is unchangedWritten down
Taken from #167: the
docker runQuick Start line for MiniStack and the note about Host-derived URLs.Verified locally: both Compose examples come up healthy, the seed completes and is skipped on a second
up, and all 35 services probe with no errors against each emulator.Addresses #166. Supersedes #167.