Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions .agents/skills/writer/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: writer
description: >
Write, edit, and restructure user-facing and developer-facing documentation.
Use when asked to create/update docs such as `README.md`, `docs/**`, and
other Markdown documentation;
other Markdown documentation, including keeping docs navigation data in sync;
when drafting tutorials, guides, troubleshooting pages, or migration notes; and
when improving inline API documentation (KDoc) and examples.
---
Expand All @@ -24,10 +24,36 @@ description: >
- `docs/`: longer-form docs (follow existing conventions in that tree).
- Source KDoc: API usage, examples, and semantics that belong with the code.

## Keep docs navigation in sync

- When adding, removing, moving, or renaming a page under
`docs/content/docs/<section>/`, keep the current version's matching
`sidenav.yml` in sync.
- Use `docs/data/versions.yml` to identify the current documentation version for
that section. The current version is the entry with `is_main: true`; its
`version_id` maps to `docs/data/docs/<section>/<version_id>/sidenav.yml`.
- Do not update historical version entries or their navigation files unless the
user explicitly asks to edit that historical version.
- Map page files to `file_path` values relative to the current version's
`content_path`, without `.md`; `_index.md` maps to its directory path, such as
`01-getting-started/_index.md` -> `01-getting-started`.
- Keep each `page` label aligned with the page frontmatter `title` unless the
existing navigation intentionally uses a shorter reader-facing label.
- Preserve the existing ordering, nesting, keys, comments, and YAML quoting
style. Remove nav entries for deleted pages and update `file_path` values for
moved pages.
Comment thread
alexander-yevsyukov marked this conversation as resolved.
- If a docs content change should not appear in navigation, say so explicitly in
the final response.

## Follow local documentation conventions

- Follow `.agents/documentation-guidelines.md` and `.agents/documentation-tasks.md`.
- Use fenced code blocks for commands and examples; format file/dir names as code.
- In Markdown files, prefer footnote-style reference links for external `https://`
targets instead of inline links. Write readable body text like
`[label][short-id]`, then place the URL definition near the end of the file,
such as `[short-id]: https://example.com/long/path`. Keep reference IDs short
and descriptive. Inline links are still fine for local relative paths.
- Avoid widows, runts, orphans, and rivers by reflowing paragraphs when needed.

## Make docs actionable
Expand All @@ -48,4 +74,3 @@ description: >

- For code changes, follow `.agents/running-builds.md`.
- For documentation-only changes in Kotlin/Java sources, prefer `./gradlew dokka`.

2 changes: 1 addition & 1 deletion buildSrc/src/main/kotlin/io/spine/dependency/local/Time.kt
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import io.spine.dependency.Dependency
)
object Time : Dependency() {
override val group = Spine.group
override val version = "2.0.0-SNAPSHOT.236"
override val version = "2.0.0-SNAPSHOT.237"
private const val infix = "spine-time"

fun lib(version: String): String = "$group:$infix:$version"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ object Validation {
/**
* The version of the Validation library artifacts.
*/
const val version = "2.0.0-SNAPSHOT.414"
const val version = "2.0.0-SNAPSHOT.415"

/**
* The last version of Validation compatible with ProtoData.
Expand Down
Loading