Skip to content

Commit 7b16cf0

Browse files
committed
docs: update copilot-chatmode and revert sidebar_position on index.md
Resolves: #1755
1 parent 6f7776e commit 7b16cf0

File tree

2 files changed

+4
-53
lines changed

2 files changed

+4
-53
lines changed

docs/docs/working-with-calm/copilot-chatmode.md

Lines changed: 3 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,9 @@ This command creates a `.github/chatmodes/CALM.chatmode.md` configuration file i
4848

4949
The chatmode setup provides GitHub Copilot with:
5050

51-
### Schema-Accurate Guidance
52-
Complete JSON schema definitions for all CALM components ensure that suggestions follow the official CALM specification.
53-
54-
### Critical Validation Requirements
55-
Emphasis on important constraints like `oneOf` requirements for interfaces and proper relationship structures.
56-
57-
### Best Practice Enforcement
58-
Guidance on naming conventions, relationship patterns, and proper architecture structure.
51+
- **Schema-Accurate Guidance**: Complete JSON schema definitions for all CALM components ensure that suggestions follow the official CALM specification.
52+
- **Critical Validation Requirements**: Emphasis on important constraints like `oneOf` requirements for interfaces and proper relationship structures.
53+
- **Best Practice Enforcement**: Guidance on naming conventions, relationship patterns, and proper architecture structure.
5954

6055
### Specialized Tools
6156

@@ -103,48 +98,6 @@ What's the recommended way to model a database relationship?
10398
Generate documentation for my CALM architecture
10499
```
105100

106-
## Benefits
107-
108-
### Intelligent Assistance
109-
Get context-aware suggestions that understand CALM schema requirements and validation rules.
110-
111-
### Faster Development
112-
Reduce the time spent looking up schema definitions and validation requirements.
113-
114-
### Error Prevention
115-
Catch common mistakes before validation by following AI-recommended best practices.
116-
117-
### Learning Tool
118-
Understand CALM concepts better through interactive explanations and examples.
119-
120-
## Troubleshooting
121-
122-
### Chatmode Not Appearing
123-
124-
If the CALM chatmode doesn't appear in VS Code:
125-
126-
1. Verify the `.github/chatmodes/CALM.chatmode.md` file exists in your repository
127-
2. Restart VS Code to reload chatmode configurations
128-
3. Ensure GitHub Copilot Chat extension is enabled and up to date
129-
4. Check that you're using VS Code 1.94 or later
130-
131-
### Copilot Doesn't Understand CALM
132-
133-
If Copilot provides generic responses instead of CALM-specific guidance:
134-
135-
1. Ensure you've selected the **CALM** chatmode (not the default chat)
136-
2. Verify the tool prompt files exist in `.github/chatmodes/calm-prompts/`
137-
3. Try restarting the GitHub Copilot service in VS Code
138-
4. Re-run `calm copilot-chatmode` to refresh the configuration
139-
140-
### Permission Issues
141-
142-
If you encounter permission errors when creating the chatmode files:
143-
144-
1. Ensure you have write permissions in the project directory
145-
2. Check that `.github/chatmodes/` directory can be created
146-
3. Run with appropriate permissions (avoid using `sudo` if possible)
147-
148101
## Updating Chatmode Configuration
149102

150103
If you update the CALM CLI or want to refresh the chatmode configuration:
@@ -158,5 +111,3 @@ This will update the chatmode files with the latest tool prompts and guidance.
158111
## Next Steps
159112

160113
- Learn about [Voice Mode](voice-mode) for hands-free architecture modeling
161-
- Explore the [Generate](generate) command to create architectures from patterns
162-
- Use [Validate](validate) to ensure your architecture meets pattern requirements

docs/docs/working-with-calm/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: working-with-calm-index
33
title: Working with CALM
4-
sidebar_position: 1
4+
sidebar_position: 3
55
---
66

77
# Working with CALM

0 commit comments

Comments
 (0)