Skip to content

Commit 2618a3a

Browse files
codekilncodekiln
committed
Add Azure OpenAI, Git restore, and repo overview documentation
- Create new pages for Azure OpenAI API version environment variable - Add Git restore --staged command explanation - Introduce repo overview template for AI coding context - Update Repomix and JSON5 pages with additional notes and references - Modify journal entries with minor content reorganization
1 parent 24500b6 commit 2618a3a

10 files changed

+68
-19
lines changed

‎journals/2025_03_05.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## [[AI Coding]]
22
- ### [[AI/LLM/Tool/Repo Summarizer]] #Filed
3-
- #### [[Repomix/Config]]
3+
- [[Repomix/Config]]
44
- added some documentation on repomix config
5-
- [[Webinar]] with [[QodoAI]] [[2025-03-11 Tue]] 9AM PST / 12PM EDT / 4PM GMT with [[Person/Itamar Friedman]] and [[Person/Harrison Chase]] - [Webinar: From Code Completion to Multi-Agent Coding Workflows](https://www.qodo.ai/webinar/from-code-completion-to-multi-agent-coding-workflows/)
5+
- [[Repomix/--compress]]
6+
- {{embed ((67c7f234-c55c-4b12-a260-d92aa3cfbb0c))}}
67
- ## Coding Language Tools
78
- [[JSON5]]
89
- {{embed ((67c822b0-3271-41da-a14f-4f023a1f4556))}}
9-
- [[Tree-Sitter]]
10-
- #Discovered via [[Repomix/--compress]] which uses it to shrink code context
11-
- {{embed ((67c7f234-c55c-4b12-a260-d92aa3cfbb0c))}}
10+
- ## LangChain ecosystem
11+
- [[Webinar]] with [[Person/Harrison Chase]] of [[LangChain]] and [[Person/Itamar Friedman]] of [[QodoAI]] [[2025-03-11 Tue]] 12PM EDT - [Webinar: From Code Completion to Multi-Agent Coding Workflows](https://www.qodo.ai/webinar/from-code-completion-to-multi-agent-coding-workflows/)
1212
- ## [[Microsoft]] ecosystem
1313
- [[o365/pptx/How To/Embed MS Stream in PowerPoint]]

‎journals/2025_03_06.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- [[Azure/OpenAI/EnvVar/OPENAI_API_VERSION]]
2+
- [[Git/restore/--staged]]
3+
-

‎pages/AI___Coding___Technique___Phased Planning___ai-coding dir.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# AI Coding technique - Using an `.ai-coding/TICKET/` dir for staging [[SDLC]] planning artifacts by SDLC Phase
1+
alias:: [[AI/Coding/Technique/Phased Planning]]
2+
3+
- # AI Coding technique - Using an `.ai-coding/TICKET/` dir for staging [[SDLC]] planning artifacts by SDLC Phase
24
- ## Summary of the `/.ai-coding/TICKET-feature-name/` directory
35
id:: 67c180c4-95f6-4d0b-b787-60d11eed3ff9
46
- Named after the ticket and a brief description of the feature; preferably the name of this directory matches the end of the branch name; `TICKET` is an external project management ticket reference.
@@ -32,13 +34,14 @@
3234
- [[CursorAI/Project Rule/cursor-project-rule-editor.mdc]]
3335
- when to suggest an update to a cursor rule
3436
- descriptions of the coding context
35-
- the repository
36-
- directory structure
37-
- purpose of the project
38-
- coding conventions
39-
- git commit format
40-
- when to commit
41-
- which [[Package Managers]] to use
37+
- [[AI/Coding/v0/File/repo-overview]] - an overview of
38+
- the repository
39+
- directory structure
40+
- purpose of the project
41+
- coding conventions
42+
- git commit format
43+
- when to commit
44+
- which [[Package Managers]] to use
4245
- Project Rules from other git submodules
4346
- Configuring a #[[Dev Container]]
4447
- provisioning API tokens, populating [[EnvVar]]s

‎pages/AI___Coding___v0___File___repo-overview.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
alias:: [[CursorAI/Project Rule/repo-overview]]
2+
3+
- # Repo Overview Instructions for AI
4+
- high-level overview to repository and its code conventions
5+
-

‎pages/Azure___OpenAI___EnvVar___OPENAI_API_VERSION.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `OPENAI_API_VERSION` -
2+
- ## [[My Notes]]
3+
- to find the latest version, go to https://learn.microsoft.com/en-us/rest/api/azureopenai/models/list and look in the model drop down at right and pick the first one that doesn't end with `-preview`

‎pages/Code___Comment.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
alias:: [[Code Comment]], [[Code Comments]]

‎pages/Git___restore___--staged.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# `git restore --staged`
2+
- It ONLY unstages files from the staging area (removes them from what would be committed)
3+
- It does NOT delete or modify any actual files
4+
- It does NOT lose any changes
5+
- The changes will still be there, just moved back to "Changes not staged for commit"
6+
- It's the newer, safer equivalent to git reset HEAD which Git introduced to make the commands more intuitive.
7+
- there

‎pages/Repomix.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ tags:: #LLMs, [[CLI/Tool]], [[AI/LLM/Tool/Repo Summarizer]]
99
- This tool can be used online
1010
- ## Usage
1111
- ## [[Repomix/Config]]
12-
- ### Specifying a Config File
12+
- See [[Repomix/repomix.config.json]] for options
13+
- ### Creating a Config File with [[repomix/--init]]
14+
- creates a config file in current dir
15+
- [[repomix/--global]] can be used with `--init` to create a global config file
16+
- ### Specifying a Config File with [[Repomix/--config]]
17+
- use with [[repomix/--global]] to utilize global config file
1318
- To use Repomix with a specific configuration file, use the following command:
1419
~~~bash
1520
npx repomix --config path/to/repomix.config.json
@@ -19,7 +24,6 @@ tags:: #LLMs, [[CLI/Tool]], [[AI/LLM/Tool/Repo Summarizer]]
1924
- Which files to include/exclude
2025
- Output format
2126
- Repository metadata
22-
- See also [[Repomix/repomix.config.json]] for options
2327
- ## [[see-also]]
2428
- [[gitingest]]
2529
-

‎pages/Repomix___Config.md‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
11
alias:: [[Repomix/repomix.config.json]]
22

33
- # Repomix Config
4-
- The config file is in [[JSON5]] which means it can have [[Code/Comments]] in it
4+
- The config file is in [[JSON5]] which means it can have [[Code/Comment]] in it
55
- ## Config File Options
66
- [[Repomix/Config/output/filePath]]
77
- The name of the output file (default: `"repomix-output.txt"`)
88
- [[Repomix/Config/output/style]]
99
- The style of the output (`plain`, `xml`, `markdown`) (default: `"plain"`)
1010
- [[Repomix/Config/output/headerText]]
1111
- Custom text to include in the file header (default: `null`)
12-
- [[Repomix/Config/output/instructionFilePath]]
13-
- Path to a file containing detailed custom instructions (default: `null`)
12+
- ### [[Repomix/Config/output/instructionFilePath]] - see [Custom Instruction](https://github.com/yamadashy/repomix/tree/main?tab=readme-ov-file#custom-instruction)
13+
- Path to **a file** containing **detailed custom instructions for the [[AI/LLM]] to include in the bundle** (default: `null`)
14+
- allows you to specify a separate file containing detailed instructions or context about your project. This allows AI systems to understand the specific context and requirements of your project.
15+
- #### #Example - this should likely be [[AI/Coding/v0/File/repo-overview]]
16+
- ```
17+
# Coding Guidelines
18+
19+
- Follow the Airbnb JavaScript Style Guide
20+
- Suggest splitting files into smaller, focused units when appropriate
21+
- Add comments for non-obvious logic. Keep all text in English
22+
- All new features should have corresponding unit tests
23+
24+
# Generate Comprehensive Output
25+
26+
- Include all content without abbreviation, unless specified otherwise
27+
- Optimize for handling large codebases while maintaining output quality
28+
```
29+
- #### [[My Notes]]
30+
- Perhaps a reference to
1431
- [[Repomix/Config/output/removeComments]]
1532
- Whether to remove comments from supported file types (default: `false`)
1633
- [[Repomix/Config/output/removeEmptyLines]]

‎pages/json___5.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,16 @@ alias:: [[JSON5]]
33
- # [JSON5 – JSON for Humans | JSON5](https://json5.org/)
44
- ## About
55
id:: 67c822b0-3271-41da-a14f-4f023a1f4556
6-
- extension to [[json]] that **aims to be easier to write and maintain by hand (e.g. for config files)**. ([[Code/Comments]] allowed)
6+
- extension to [[json]] that **aims to be easier to write and maintain by hand (e.g. for config files)**.
77
- superset of [[json]]; valid JSON files will always be valid JSON5 files
88
- a subset of [[ES5]]; valid JSON5 files will always be valid ES5
99
- expands its syntax to include some productions from [ECMAScript 5.1](https://www.ecma-international.org/ecma-262/5.1/) (ES5).
10+
- ### [[My Notes]]
11+
- allows
12+
- [[Code/Comment]] (both single-line and multi-line)
13+
- Trailing commas in objects and arrays
14+
- Unquoted property names
15+
- More relaxed string syntax
1016
- ## #Example
1117
- ```json5
1218
{

0 commit comments

Comments
 (0)