Skip to content

Fix Go version, update CI, and enhance documentation templates#10

Merged
jbrazda merged 13 commits intomainfrom
dev
Mar 10, 2026
Merged

Fix Go version, update CI, and enhance documentation templates#10
jbrazda merged 13 commits intomainfrom
dev

Conversation

@jbrazda
Copy link
Copy Markdown
Owner

@jbrazda jbrazda commented Mar 10, 2026

Summary

Add Documentation

Changes

  • Add Comprehensive documentation

Testing

  • make test passes
  • make lint passes

Related Issues

Closes
#9, #8, #7, #5, #4

jbrazda added 13 commits March 10, 2026 07:48
- Downgrade go directive from 1.25.0 to 1.24.0 to match CI matrix
- Add Commit Style section to CLAUDE.md to suppress Co-Authored-By trailers
- Update CI matrix from [1.23, 1.24] to [1.24, 1.25] to match go.mod minimum
- Pin build and lint jobs to Go 1.25
- Fix TestGetConnection and TestDeleteConnection to expect correct V2 API paths
- Add version: "2" to .golangci.yml
- Move linters-settings into linters.settings per v2 schema
- Revert ci.yml golangci-lint version back to latest
- errcheck: wrap defer Close() calls, suppress fmt.Print*/Scan* errors with _ =
- govet/shadow: restructure err variable declarations to avoid shadowing
- misspell: honour -> honor in cmd/objects.go
- staticcheck: replace WriteString(fmt.Sprintf()) with fmt.Fprintf()
- errcheck: wrap defer Close() calls, suppress fmt.Print*/Scan*/os.Remove with _ =
- govet/shadow: fix err shadowing in cmd/logout.go
- misspell: Cancelled -> Canceled in cmd files
- Remove now-unnecessary //nolint:errcheck comments
…ctions

- Add docs/templates/Bug-Template.md: structured bug report with architecture
  layer selector, API details section, and scoped fix instructions for Claude
- Add docs/templates/CR-Template.md: comprehensive CR template with CR type
  selector, full scope/API/implementation/acceptance-criteria sections
- Move templates from docs/ChangeRequests/ to docs/templates/ (canonical location)
- Move completed issues from docs/issues/new/ to docs/issues/completed/
- Update CLAUDE.md: add Markdown lint rule, fix docs/CLAUDE.md link
- Update docs/CLAUDE.md: apply markdownlint fixes (fenced code language, table
  alignment, blank lines before lists)
- Update docs/HOW-TO-Vibe.md: fix unclosed code fence and add text language tag
…rule

Replace all em dash characters (-) with regular hyphens (-) across every
.md file. Add an explicit rule to CLAUDE.md and docs/CLAUDE.md instructing
Claude not to use em dashes in generated Markdown content.
Create docs/documentation/ with one Markdown file per top-level command
(22 files total). Each page covers synopsis, flags table, output columns,
practical examples, and cross-links to related commands.

Commands documented: login, logout, objects, lookup, connection, export,
import, project, folder, schedule, user, usergroup, role, privilege,
runtime, agent, tag, permission, securitylog, metering, sourcecontrol, state.

Update README.md: replace the plain command tree with a linked command
reference table, add --debug to the global flags table, fix the
"DevelopmentPP" heading typo, and add csv to the --output description.
@jbrazda jbrazda merged commit c54f19a into main Mar 10, 2026
18 checks passed
@jbrazda jbrazda deleted the dev branch March 10, 2026 21:48
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.

1 participant