[OCaml] Mobile-friendly clone of cgit.
docs add config steering rule and sample config.toml
Steering now requires a fully-commented sample config file that documents every variable with its default and allowed values. Created config.toml.sample as the reference.
Changed files
.kiro/steering/ocaml.md
@@ -37,3 +37,11 @@
37
37
38
38
- This repository SHALL use Org Mode for project documentation. New project docs SHALL use `.org` files.
39
39
- Architecture docs SHALL be updated when MQTT topics, payload schema, host roles, or data flow change.
40
Added:
41
Added:
## Configuration
42
Added:
43
Added:
- The project SHALL include a sample `config.toml` file (at the project root or a documented location) that serves as reference documentation.
44
Added:
- The sample configuration file SHALL be fully commented out (all key = value lines prefixed with `#`).
45
Added:
- Every configurable variable SHALL appear in the sample file with its default value.
46
Added:
- Each variable SHALL be preceded by a comment explaining the variable's purpose and other permissible values (e.g. types, allowed ranges, examples).
47
Added:
- When a configuration variable is added or changed, the sample file SHALL be updated in the same commit.
config.toml.sample
@@ -0,0 +1,45 @@
1
Added:
# ogit sample configuration file
2
Added:
# Copy to $XDG_CONFIG_HOME/ogit/config.toml or /etc/ogit/config.toml,
3
Added:
# or set OGIT_CONFIG to point to a custom location.
4
Added:
# Uncomment and modify values as needed.
5
Added:
6
Added:
# Username displayed in the page footer and default title.
7
Added:
# Type: string
8
Added:
# user = "git"
9
Added:
10
Added:
# Default branch to resolve when HEAD is detached or missing.
11
Added:
# Type: string
12
Added:
# default_branch = "main"
13
Added:
14
Added:
# Filesystem path containing bare or non-bare git repositories.
15
Added:
# Type: string (absolute path)
16
Added:
# git_project_root = "/home/git/git"
17
Added:
18
Added:
# Maximum number of commits shown on the summary page.
19
Added:
# Type: integer (must be positive)
20
Added:
# commits_max_displayed = 10
21
Added:
22
Added:
# Site title shown in the navigation bar. When empty, defaults to
23
Added:
# "Repositories for <user>".
24
Added:
# Type: string
25
Added:
# title = ""
26
Added:
27
Added:
# Network interface to bind the HTTP server to.
28
Added:
# Type: string (IP address)
29
Added:
# host = "127.0.0.1"
30
Added:
31
Added:
# TCP port for the HTTP server.
32
Added:
# Type: integer (1–65535)
33
Added:
# port = 8081
34
Added:
35
Added:
# Repositories or directories to highlight in a "Favorites" section
36
Added:
# at the top of the root page. Use the repo directory name for repos
37
Added:
# (e.g. "myproject.git") or a directory name with trailing slash for
38
Added:
# groups (e.g. "important/").
39
Added:
# Type: array of strings
40
Added:
# favorite_repositories = []
41
Added:
42
Added:
# Repositories or directories to collect in an "Archived" section
43
Added:
# at the bottom of the root page. Same naming convention as above.
44
Added:
# Type: array of strings
45
Added:
# archived_repositories = []