docs: remove code snippets from main README #631
Merged
Conversation
This file contains 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
We want to delegate it to the docs site, as it will be up-to-date
mdelapenya
referenced
this pull request
in mdelapenya/testcontainers-go
Nov 29, 2022
* main: Add toxiproxy example (testcontainers#643) Add spanner example (testcontainers#642) chore: sync governance files (testcontainers#641) Add pubsub example (testcontainers#640) chore: adjust generator for the docs site (testcontainers#639) Add datastore example (testcontainers#638) Add firestore example (#637) fix: avoid panics when checking container state and container.raw is nil (#635) feat: provide a tool to generate examples from code (#618) chore: bump version in mkdocs (#630) docs: remove code snippets from main README (#631) docs: document replace directive for Docker Compose (#632)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We want to delegate it to the docs site, as it will be up-to-date
What does this PR do?
It removes code snippets from the main README, linking to the docs site instead.
Why is it important?
To avoid having the snippets outdated, we are removing it from the README. The website will eventually contain real code that is executed through tests, therefore providing a real example on how to use the library.
Related issues
nginxC.Terminate#627