[DRAFT] Expanded C# coding style guide development work and process documentation #58
+2,248
−0
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
This commit preserves the current state before cleanup. Content has been copied to genesis with the following organization: - docs/guide-development/meta-insights/ -> C:/src/genesis/philosophy/meta-insights/ - docs/guide-development/knowledge-movement-system/ -> C:/src/genesis/philosophy/knowledge-movement-system/ - docs/framework/ -> C:/src/genesis/process/documentation-framework/ - docs/guide-development/*-draft.md -> C:/src/genesis/education/ - todo/top-self-help-books-frameworks.jsonl -> C:/src/genesis/pitch/frameworks/ Remaining content is focused on coding style guidelines and code review processes.
Removed directories and files that were copied to genesis: - docs/guide-development/meta-insights/ (moved to genesis/philosophy/) - docs/guide-development/knowledge-movement-system/ (moved to genesis/philosophy/) - docs/framework/ (moved to genesis/process/documentation-framework/) - Educational draft files (moved to genesis/education/) - todo/top-self-help-books-frameworks.jsonl (moved to genesis/pitch/frameworks/) - todo/self-help-books-2016-to-2023.md (duplicate of genesis/pitch/frameworks/overview.md) Branch now focuses on: - Core coding style guidelines (C#-Coding-Style-Essential.md, C#-Coding-Style-Expanded.md) - Code review processes - Standard cycod documentation
robch
changed the title
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 is a draft PR containing development work for expanding the C# coding style documentation.
What's in this PR:
This PR contains development artifacts and work-in-progress content for creating expanded coding style documentation with concrete analogies and educational content.
Development Planning Documents:
docs/guide-development/expanded-guide-plan.md- Development roadmap using ASK frameworkdocs/guide-development/sections-ready-for-integration.md- Staging area for completed sectionsdocs/guide-development/integration-summary.md- Development process documentationDraft Content Sections (with analogies):
docs/guide-development/cooking-null-handling-revised.md- Null handling with cooking analogiesdocs/guide-development/hospital-exception-handling-revised.md- Exception handling with medical analogiesdocs/guide-development/updated-async-programming-section.md- Async programming with restaurant kitchen analogiesDevelopment Artifacts:
docs/guide-development/inventory-section-*.md- Content inventory and analysisdocs/guide-development/section-3-*.md- Framework validation workProcess Documentation:
todo/code-review-tool-integration-ideas.md- Ideas for integrating code review processes with toolingStatus:
Next Steps:
This PR serves as a workspace for developing enhanced coding style documentation with educational analogies. Content may be extracted and refined for future integration into the main documentation.