Skip to content

Commit 569a763

Browse files
committed
refactor: remove optional Git hooks setup task and update examples documentation
1 parent 4a1b036 commit 569a763

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

Taskfile.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,6 @@ tasks:
2121
- echo "Setup complete! Changelog is automatically generated via GitHub Actions."
2222
silent: true
2323

24-
setup:hooks:
25-
desc: Configure Git to use project hooks directory (optional - changelog now generated via GitHub Actions)
26-
cmds:
27-
- git config core.hooksPath .githooks
28-
- chmod +x .githooks/pre-commit
29-
- echo "Git hooks configured! Note: Changelog is now automatically generated via GitHub Actions on push to main."
30-
3124
build:
3225
desc: Build the MkDocs site
3326
cmds:

docs/examples.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
11
# Examples
22

3-
- [Codebase Interface](https://github.com/codebase-interface/codebaseinterface){target="_blank"}
3+
- [Codebase Interface](https://github.com/codebase-interface/codebaseinterface){target="_blank"}
4+
5+
??? example "Directory Interface Example"
6+
Here's the codebase interface directory implementation:
7+
8+
```txt
9+
├── AGENTS.md # Documentation for AI agents that interact with this codebase
10+
├── CHANGELOG.md # Documentation of notable changes
11+
├── CODE_OF_CONDUCT.md # Code of conduct for contributors
12+
├── CONTRIBUTING.md # How to contribute to this codebase
13+
├── LANGUAGE.md # Ubiquitous language for this codebase
14+
├── LICENSE.md # License for this codebase
15+
├── PULL_REQUEST_TEMPLATE.md # Template for pull requests
16+
├── README.md # Overview of this codebase for users
17+
├── RUNBOOK.md # Operational documentation for operators
18+
├── SECURITY.md # Security policy for this codebase
19+
├── SUPPORT.md # Support guidelines for this codebase
20+
├── TODO.md # List of tasks to be completed
21+
├── Taskfile.yml # Taskfile for managing tasks
22+
├── cliff.toml # Configuration file for the Cliff tool
23+
├── docs # Documentation directory
24+
│ ├── README.md # Main documentation landing page
25+
│ └── ...
26+
├── mkdocs.yml # MkDocs configuration file
27+
├── .editorconfig # Editor configuration file
28+
├── .gitattributes # Git attributes file
29+
├── .gitignore # Git ignore file
30+
└── .editorconfig # Editor configuration file
31+
32+
```

0 commit comments

Comments
 (0)