Skip to content

Conversation

Copy link

Copilot AI commented Jan 27, 2026

Technical review of ./docs/doc-site identified typos, broken relative paths, and code examples using wrong package imports.

Typos & Grammar

  • "Mimicks" → "Mimics" (api/_index.md, api/testing.md)
  • "De factor" → "De facto", "requiredl" → "required"
  • "Ginkgo/Omega" → "Ginkgo/Gomega"
  • Singular/plural: "test wanted" → "tests wanted"

Broken Links

  • Fixed ../../api/_index.md../api/_index.md (files in usage/ only need one level up)
  • Fixed ./usage/examples./usage/EXAMPLES.md (case sensitivity)
  • Fixed ../../project/maintainers/BENCHMARKS.md paths

Wrong Package Imports

Code examples incorrectly referenced gotest.tools/assert (a different package entirely) and old github.com/stretchr/testify/assert imports:

// Before (wrong package)
import "gotest.tools/assert"

// After
import "github.com/go-openapi/testify/v2/assert"

Content

  • Filled empty "Import the package" code block in USAGE.md
  • Fixed inconsistent indentation in setup/teardown example

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • go-openapi.github.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 27, 2026 22:42
Co-authored-by: fredbi <14262513+fredbi@users.noreply.github.com>
Co-authored-by: fredbi <14262513+fredbi@users.noreply.github.com>
Copilot AI changed the title [WIP] Review and correct documentation for go-openapi library Fix documentation typos, broken links, and inconsistent import paths Jan 27, 2026
Copilot AI requested a review from fredbi January 27, 2026 22:49
@fredbi fredbi marked this pull request as ready for review January 27, 2026 22:50
Copy link
Member

Choose a reason for hiding this comment

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

comes from doc generator. Have to fix the original source ./internal/assertions/doc.go

@codecov
Copy link

codecov bot commented Jan 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.66%. Comparing base (3bd6a9b) to head (49b4be5).
⚠️ Report is 1 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #50   +/-   ##
=======================================
  Coverage   96.66%   96.66%           
=======================================
  Files          53       53           
  Lines        8227     8227           
=======================================
  Hits         7953     7953           
  Misses        182      182           
  Partials       92       92           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

Choose a reason for hiding this comment

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

incorrect imports have been inserted by mdsf. Have to check why on next run

@fredbi fredbi merged commit b33472c into master Jan 27, 2026
20 checks passed
@fredbi fredbi deleted the copilot/review-docs-corrections branch January 27, 2026 22:57
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.

2 participants