Skip to content

docs: add Go and Jasmine reporter guides - #9

Merged
hasanalituran merged 7 commits into
mainfrom
codex/docs-new-reporters-seo-geo
Aug 22, 2026
Merged

docs: add Go and Jasmine reporter guides#9
hasanalituran merged 7 commits into
mainfrom
codex/docs-new-reporters-seo-geo

Conversation

@hasanalituran

Copy link
Copy Markdown
Contributor

Summary

  • Add complete Go and Jasmine reporter setup guides based on the current reporter packages.
  • Add both reporters to the sidebar, homepage cards, README, Introduction, Installation matrix, and Rovo setup guidance.
  • Add both guides to static/llms.txt with canonical docs URLs.
  • Keep existing robots.txt, sitemap configuration, IndexNow, and generic WebPage JSON-LD behavior unchanged; verify those surfaces through the generated build.
  • Remove unavailable private sample-repository links from the public docs.

Validation

  • npm run typecheck
  • npm run build
  • npm run test:indexnow
  • npm run indexnow:dry-run -- --sitemap build/sitemap.xml
  • Generated canonical, WebPage JSON-LD, sitemap, llms.txt, homepage, and robots.txt assertions for both new URLs
  • git diff origin/main...HEAD --check

The production build completed successfully. It emitted only existing Webpack cache permission warnings from the local environment.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2773375de0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/reporters/go.md
Comment on lines +111 to +112
--project ./services/api \
--go-packages ./services/api/...

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Make the package selector relative to the project

When the Go module is located at ./services/api, --project establishes that directory as the project root, so passing ./services/api/... again makes go test look for services/api/services/api and fail with “directory prefix … does not contain main module.” Go treats dot-prefixed package patterns as filesystem paths relative to the working directory (Go package-list documentation); use --go-packages ./... here or omit it because that is already the default.

Useful? React with 👍 / 👎.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0acc9f9ca7

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/reporters/jasmine.md
jasmine.getEnv().addReporter(
new TestreamJasmineReporter({
apiKey: process.env.TESTREAM_API_KEY,
uploadEnabled: process.env.TESTREAM_UPLOAD_ENABLED === "true",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Preserve the default upload behavior

When a user follows this basic configuration with only TESTREAM_API_KEY set, an unset TESTREAM_UPLOAD_ENABLED evaluates to false, overriding the reporter's documented true default and causing npx jasmine to write a local report without uploading it. Default this expression to enabled when the variable is absent, or explicitly instruct users to set the additional variable before the first run.

Useful? React with 👍 / 👎.

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