docs: Split documentation into template author and developer sections - #21
Merged
Conversation
Configure .editorconfig to enforce code style as warnings: - IDE0011: Require braces for all if statements - IDE0040: Require explicit accessibility modifiers - IDE1006: Enforce naming conventions (private fields with _ prefix) Apply formatting fixes across codebase: - Fix line endings (CRLF→LF) in GUI project files - Add braces to single-line if statements - Add accessibility modifiers where missing - Format code according to all .editorconfig rules Changes applied via dotnet format. All 690 tests passing. Build now completes with zero warnings.
Split documentation into two clear audiences to improve accessibility: - Template Authors: Non-technical users creating Word templates (JSON only, no C# code) - Developers: Technical users integrating the library (C# API, examples, architecture) ## Changes ### New Template Author Documentation (docs/for-template-authors/) - getting-started.md - 5-minute intro with JSON examples - json-basics.md - Beginner-friendly JSON tutorial - template-syntax.md - Complete syntax reference - placeholders.md - Placeholder usage guide - conditionals.md - If/else logic guide - loops.md - Foreach loops guide - best-practices.md - Tips and troubleshooting - examples-gallery.md - Visual examples gallery - Moved format-specifiers.md from guides/ - Moved boolean-expressions.md from guides/ ### New Developer Documentation (docs/for-developers/) - quick-start.md - Placeholder linking to existing dev docs ### Updated Landing Page (docs/index.md) - Added audience selector at top - Clear paths: "I Create Word Templates" vs "I'm a Developer" - Removed C# code from main example (switched to JSON) - Simplified structure for better UX ### Updated Navigation (mkdocs.yml) - New "For Template Authors" section with all guides - New "For Developers" section (placeholder) - Kept existing Tutorials and FAQ - Marked old Quick Start as "Legacy" ### Fixed Broken Links - docs/FAQ.md: 2 links updated to new paths - docs/quick-start.md: 2 links updated to new paths - docs/tutorials/index.md: 2 links updated to new paths ### Additional Files - examples/README.md - Instructions for downloadable examples ## Impact - Template authors never see C# code or Dictionary<string, object> - All template author examples use JSON only - Beginner-friendly JSON basics explained from scratch - Clear separation of concerns for different user types ## Related Remaining cleanup tracked in #20
There was a problem hiding this comment.
Pull request overview
This PR reorganizes documentation to separate content for two distinct audiences: template authors (non-technical users working with Word and JSON) and developers (integrating the C# library). The changes include 10 comprehensive template author guides (~25,000 words) with JSON-only examples, updated navigation, a revised landing page with audience selector, and fixes for broken internal links.
Reviewed changes
Copilot reviewed 15 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updated navigation to add "For Template Authors" (10 guides) and "For Developers" sections, moved old Quick Start to legacy |
| docs/index.md | Added audience selector with clear paths for template authors vs developers, switched main example from C# to JSON |
| docs/for-template-authors/*.md | 10 new comprehensive guides covering JSON basics, syntax, placeholders, conditionals, loops, format specifiers, boolean expressions, best practices, examples gallery, and getting started |
| docs/for-developers/quick-start.md | Placeholder stub linking to existing technical documentation |
| docs/FAQ.md | Fixed 2 broken links to format-specifiers and boolean-expressions guides |
| docs/quick-start.md | Fixed 2 broken links to moved guides |
| docs/tutorials/index.md | Fixed 2 broken links referencing old guides directory |
| examples/README.md | New file with instructions for using downloadable example templates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+173
to
+175
| "Years | ||
|
|
||
| Experience": 5, |
There was a problem hiding this comment.
Invalid JSON: The key name \"Years\n\nExperience\" is split across multiple lines. This should be \"YearsExperience\" to match the template usage on line 183 and to be valid JSON.
Suggested change
| "Years | |
| Experience": 5, | |
| "YearsExperience": 5, |
Fixed multi-line key name 'Years\n\nExperience' to 'YearsExperience' to match template placeholder and create valid JSON. Addresses Copilot review comment on PR #21.
Contributor
Author
|
✅ Fixed! Changed the multi-line JSON key to |
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.
Summary
Comprehensive documentation reorganization that splits content into two clear audiences:
This improves accessibility for non-developers while maintaining comprehensive technical documentation.
Changes
📝 New Template Author Documentation (
docs/for-template-authors/)Created 9 comprehensive guides (25,000+ words) with zero C# code, JSON-only examples:
docs/guides/docs/guides/💻 New Developer Documentation (
docs/for-developers/)🏠 Updated Landing Page (
docs/index.md)🗺️ Updated Navigation (
mkdocs.yml)🔗 Fixed Broken Links
Fixed 6 internal links pointing to old file locations:
docs/FAQ.md- 2 links updateddocs/quick-start.md- 2 links updateddocs/tutorials/index.md- 2 links updated📦 Additional Files
examples/README.md- Instructions for using downloadable example templatesWhy This Matters
Before
Dictionary<string, object>examplesAfter
Testing
mkdocs serve)Live Preview: http://127.0.0.1:8001/templify/ (local)
Related Issues
Partially addresses #20 - This PR implements the main documentation split and fixes all broken links. Remaining optional cleanup items (missing tutorial files, legacy directory removal) are tracked in #20.
Checklist
Screenshots
New Landing Page with Audience Selector
(View at http://127.0.0.1:8001/templify/)
Template Author Documentation Structure
File Changes
17 files changed:
New files: 10 template author guides, 1 developer placeholder, 1 examples README
Modified files: Landing page, navigation, 3 files with fixed links
Moved files: 2 guides (format-specifiers, boolean-expressions)