[DX-3059] Prepare local CRE docs for central docs #21833
Open
[DX-3059] Prepare local CRE docs for central docs #21833
Conversation
Contributor
|
✅ No conflicts with other open PRs targeting |
skudasov
previously approved these changes
Apr 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Risk Rating: LOW
This PR migrates the long-form Local CRE + CRE smoke-test documentation out of legacy READMEs into the docs/local-cre/ doc set, leaving behind short pointers/quickstarts in the original locations.
Changes:
- Replaced large legacy READMEs under
core/scripts/cre/environment/andsystem-tests/tests/smoke/cre/with links into the new docs tree. - Added a structured Local CRE documentation set under
docs/local-cre/(Getting Started, Environment, System Tests, Reference). - Introduced Docusaurus category metadata files (
_category_.yaml) to define sidebar structure.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| system-tests/tests/smoke/cre/README.md | Replaced long smoke-test README with links + a short quickstart. |
| core/scripts/cre/environment/README.md | Replaced long Local CRE README with links + a short quickstart/contact. |
| docs/index.md | Adds an entrypoint page for the CRE docs bundle. |
| docs/local-cre/index.md | Adds Local CRE overview/IA entrypoint. |
| docs/local-cre/category.yaml | Defines the Local CRE docs category in the sidebar. |
| docs/local-cre/getting-started/index.md | Adds a concise “clean checkout → running env → first smoke run” guide. |
| docs/local-cre/getting-started/category.yaml | Sidebar category metadata for Getting Started. |
| docs/local-cre/environment/index.md | Documents core CLI usage and environment lifecycle. |
| docs/local-cre/environment/workflows.md | Documents workflow deploy/delete operations and flags. |
| docs/local-cre/environment/topologies.md | Documents topology selection/inspection and capability placement concepts. |
| docs/local-cre/environment/advanced.md | Adds advanced operational topics (swaps, telemetry/tracing, k8s, etc.). |
| docs/local-cre/environment/category.yaml | Sidebar category metadata for Environment. |
| docs/local-cre/system-tests/index.md | Introduces System Tests landing page + smoke vs regression guidance. |
| docs/local-cre/system-tests/running-tests.md | Documents local/CI execution, env vars, parallelism, and bucketing. |
| docs/local-cre/system-tests/workflows-in-tests.md | Documents recommended helper patterns for workflow compilation/deploy. |
| docs/local-cre/system-tests/ci-and-suite-maintenance.md | Documents CI discovery/matrix patterns and suite maintenance guidance. |
| docs/local-cre/system-tests/category.yaml | Sidebar category metadata for System Tests. |
| docs/local-cre/reference/index.md | Adds “source anchors” / commands / generated artifacts reference page. |
| docs/local-cre/reference/category.yaml | Sidebar category metadata for Reference. |
Suggested reviewers (CODEOWNERS): @smartcontractkit/core, @smartcontractkit/foundations (root ownership applies to these paths per .github/CODEOWNERS).
|
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
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.
No description provided.