Automated documentation update #3
Conversation
There was a problem hiding this comment.
Pull request overview
This PR performs an automated documentation update for devcontainer features, regenerating README files from their respective devcontainer-feature.json files. The update standardizes documentation format across all features by removing extensive manual content and simplifying to a consistent auto-generated template.
Key changes include:
- Simplifying feature descriptions and removing verbose documentation
- Standardizing the format for options tables and VS Code extensions lists
- Updating the feature reference format from
ghcr.io/molcrafts/devcontainers/*:latesttoghcr.io/MolCrafts/devcontainers/*:0
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| features/src/molvis/README.md | Creates new auto-generated documentation for the molvis devcontainer feature |
| features/src/molrs/README.md | Simplifies from detailed Python documentation to minimal Rust environment documentation |
| features/src/molpy/README.md | Reduces comprehensive Python/molecular science documentation to simplified auto-generated format |
| features/src/molnex/README.md | Streamlines from detailed ML/CUDA documentation to basic auto-generated template |
| features/src/molexp/README.md | Simplifies from extensive task graph framework documentation to minimal auto-generated format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| --- | ||
|
|
||
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molvis/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
There was a problem hiding this comment.
There are two spaces between "devcontainer-feature.json)." and "Add" in this auto-generated note, while other files in this PR have the same spacing inconsistency. This should be a single space for consistency with standard English spacing conventions.
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molvis/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ | |
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molvis/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
| --- | ||
|
|
||
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molrs/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ | ||
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molrs/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
There was a problem hiding this comment.
There are two spaces between "devcontainer-feature.json)." and "Add" in this auto-generated note. This should be a single space for consistency with standard English spacing conventions.
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molrs/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ | |
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molrs/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
| --- | ||
|
|
||
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molpy/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ | ||
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molpy/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
There was a problem hiding this comment.
There are two spaces between "devcontainer-feature.json)." and "Add" in this auto-generated note. This should be a single space for consistency with standard English spacing conventions.
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molpy/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ | |
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molpy/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
| ```bash | ||
| python3 -c "import torch; print(f'GPU: {torch.cuda.get_device_name(0)}')" | ||
| ``` | ||
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molnex/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
There was a problem hiding this comment.
There are two spaces between "devcontainer-feature.json)." and "Add" in this auto-generated note. This should be a single space for consistency with standard English spacing conventions.
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molnex/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ | |
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molnex/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
| --- | ||
|
|
||
| For more information, visit the [molexp repository](https://github.com/MolCrafts/molexp). | ||
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molexp/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
There was a problem hiding this comment.
There are two spaces between "devcontainer-feature.json)." and "Add" in this auto-generated note. This should be a single space for consistency with standard English spacing conventions.
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molexp/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ | |
| _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MolCrafts/devcontainers/blob/main/features/src/molexp/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |
Roy-Kid
force-pushed
the
master
branch
2 times, most recently
from
823b3cb to
dc525c3
Compare
Automated documentation update