docs: comprehensive documentation audit and formatting improvements - #115
Merged
Conversation
- Refactored CLIcore.md and scripting.md with collapsible sections - Removed milk-cli prompts and added shebangs to scripting docs - Updated documentation rules to enforce shebangs in code blocks - Fixed obsolete git branch and CI references in developer guides
oguyon
added a commit
that referenced
this pull request
May 21, 2026
…115) - Refactored CLIcore.md and scripting.md with collapsible sections - Removed milk-cli prompts and added shebangs to scripting docs - Updated documentation rules to enforce shebangs in code blocks - Fixed obsolete git branch and CI references in developer guides
oguyon
added a commit
that referenced
this pull request
May 21, 2026
…115) - Refactored CLIcore.md and scripting.md with collapsible sections - Removed milk-cli prompts and added shebangs to scripting docs - Updated documentation rules to enforce shebangs in code blocks - Fixed obsolete git branch and CI references in developer guides
oguyon
added a commit
that referenced
this pull request
May 22, 2026
…115) - Refactored CLIcore.md and scripting.md with collapsible sections - Removed milk-cli prompts and added shebangs to scripting docs - Updated documentation rules to enforce shebangs in code blocks - Fixed obsolete git branch and CI references in developer guides
DasVinch
pushed a commit
that referenced
this pull request
May 29, 2026
…115) - Refactored CLIcore.md and scripting.md with collapsible sections - Removed milk-cli prompts and added shebangs to scripting docs - Updated documentation rules to enforce shebangs in code blocks - Fixed obsolete git branch and CI references in developer guides
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
1 participant
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.
Prompt Summary
The user requested a full audit of the project documentation to find and fix obsolete information, ensure proper cross-referencing, use collapsible
<details>blocks for extremely long pages, and enforce new documentation standards (e.g., removing CLI prompts from script examples so they can be copy-pasted directly).This PR addresses the following:
<details>blocks throughoutdocs/cli/CLIcore.mdanddocs/cli/scripting.mdto drastically improve readability on very long API/reference pages.milk-cli >prompts from all script code blocks indocs/cli/scripting.mdand added#!/usr/bin/env milk-cli -sshebangs, allowing scripts to be copy-pasted and run directly..agents/rules/documentation-standards.mdrequiring shebangs instead of CLI prompts in code examples moving forward.docs/developer/LoadingModules.md: Updated Git branching instructions to referencemainandframework-devinstead of the legacymasteranddevbranches.docs/developer/DocumentingCode.md: Updated the API Reference CI file path fromdoxygen.ymltodocs.ymland the trigger branch fromdevtoframework-dev.AI Authorship