docs: incorporate documentation review feedback from PR #16 #31
Conversation
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
Plus some additional fixes that seem to work for me
- Add command prerequisites (build after init, start after init and build) - Add 'How defaults work' section explaining config generation - Update Run ID format to ISO8601 (YYYYMMDDTHHMM_RandomName) - Improve Step Context documentation with cross-references - Update Portainer section formatting and add documentation link - Clarify container descriptions (shared database, dynamic ports) - Add version strategy section for repository management - Simplify configuration sharing from 3-step to 2-step process - Normalize timing claims to percentages (~40% improvement) - Update directory structure examples to use ISO8601 format Addresses review feedback from @BigLep in PR #16
- Fix README.md link syntax for configuration system reference - Replace GitHub links with relative paths in Advanced_Readme.md: - src/config.rs links now use relative path - src/commands/start/steps/ links now use relative path - Improves local documentation browsing and offline access
Contributor
Author
|
(I didn't confirm if this has everything yet. I probably am out of time to work on this.) |
Collaborator
|
Consider creating a new PR targeting |
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.
This PR incorporates the documentation review feedback from @BigLep in PR #16.
Changes
Addresses review feedback from PR #16.