docs: add scaffolding for testcontainers docs system #624
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.
What does this PR do?
It adds the base Mkdocs project for the testcontainers docs system.
It uses tc-go as reference, removing all the go-specific content but the general one.
Why is it important?
Homogeneous and consistent docs system across testcontainers projects.
How to test this PR
As described in the
docs/contributing_docs.md
file in this PR:python3 -m venv tc-venv
.source tc-venv/bin/activate
.pip3 install -r requirements.txt && ./tc-venv/bin/mkdocs serve
from thetestcontainers-rs
root directory. It will start a local auto-updating MkDocs server.Follow-ups