Skip to content

Document documentation submodule internals and workflows#297

Merged
alexander-yevsyukov merged 40 commits into
masterfrom
document-documentation
May 12, 2026
Merged

Document documentation submodule internals and workflows#297
alexander-yevsyukov merged 40 commits into
masterfrom
document-documentation

Conversation

@alexander-yevsyukov
Copy link
Copy Markdown
Collaborator

@alexander-yevsyukov alexander-yevsyukov commented May 11, 2026

This PR adds the documentation section to the “Validation developer guide”. The new section describes Gradle/Hugo setup and developer's tasks around it.

Copilot AI review requested due to automatic review settings May 11, 2026 16:38
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the published Validation snapshot version references across build/version configuration and documentation examples, and adds some repository hygiene/docs-planning tweaks.

Changes:

  • Bump validationVersion to 2.0.0-SNAPSHOT.419 and update the same version in docs snippets.
  • Normalize the Apache 2.0 license link in docs/build.gradle.kts to HTTPS.
  • Add Kotlin file patterns to .gitattributes and introduce an internal .agents task doc for documenting the documentation process.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
version.gradle.kts Bumps the library publish version to 2.0.0-SNAPSHOT.419.
docs/content/docs/validation/user/01-getting-started/adding-to-build.md Updates the plugin version shown in the “adding to build” example.
docs/content/docs/validation/developer/build-and-release.md Updates the referenced validationVersion snippet in developer docs.
docs/build.gradle.kts Updates the Apache 2.0 license URL to https.
.gitattributes Adds *.kt / *.kts as normalized text files.
.agents/tasks/describe-documentation-plan.md Adds an internal task document; contains a few typos/wording issues.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .agents/tasks/describe-documentation-plan.md Outdated
Comment thread .agents/tasks/describe-documentation-plan.md Outdated
Comment thread .agents/tasks/describe-documentation-plan.md Outdated
Comment thread .agents/tasks/describe-documentation-plan.md Outdated
Comment thread version.gradle.kts
@alexander-yevsyukov alexander-yevsyukov changed the title Document documentation Document documentation submodule internals and workflows May 11, 2026
@alexander-yevsyukov alexander-yevsyukov self-assigned this May 11, 2026
Copilot AI review requested due to automatic review settings May 11, 2026 20:18
@alexander-yevsyukov alexander-yevsyukov marked this pull request as ready for review May 11, 2026 20:21
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.

Comment thread dependencies.md
Comment thread docs/content/docs/validation/developer/documentation/procedures.md
Copilot AI review requested due to automatic review settings May 11, 2026 20:50
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 3 comments.

Comment thread dependencies.md
Comment thread docs/content/docs/validation/developer/documentation/procedures.md
Copy link
Copy Markdown
Collaborator

@armiol armiol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexander-yevsyukov to prevent from an accidental merge, requesting the changes :) Please see my suggestions.

Comment thread docs/content/docs/validation/developer/documentation/_index.md
Comment thread docs/content/docs/validation/developer/documentation/embedded-examples.md Outdated
Comment thread docs/content/docs/validation/developer/documentation/procedures.md
Comment thread docs/content/docs/validation/developer/documentation/procedures.md Outdated
Copilot AI review requested due to automatic review settings May 12, 2026 15:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 3 comments.

Comment thread dependencies.md
Comment thread docs/content/docs/validation/developer/documentation/build-tasks.md
Comment thread docs/content/docs/validation/developer/documentation/procedures.md
@alexander-yevsyukov alexander-yevsyukov merged commit 193cbc1 into master May 12, 2026
8 checks passed
@alexander-yevsyukov alexander-yevsyukov deleted the document-documentation branch May 12, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants