Skip to content

Describe the Intelligence API on the home page instead of documenting it - #139

Merged
jasonnorch merged 1 commit into
mainfrom
feat/home-product-copy
Nov 12, 2026
Merged

jasonnorch merged 1 commit into
mainfrom
feat/home-product-copy

Conversation

@jasonnorch

@jasonnorch jasonnorch commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

The home page's Product section listed every lookup for domains and IPs and showed a sample request and response. That is what the docs are for, and they are one link away. It also made the home page a second place every new lookup had to be added.

What changes

  • The lookup lists and the request/response code blocks are removed from home.html.
  • In their place: a short description of what the API is for, and three points (one place to ask, made for automation, clear about freshness). The links to the domain and IP references stay.
  • A new lookup no longer touches the home page. The adding-features checklist and the docs-pages rule are updated to say so, and docs/decisions.md records why the reference material came off.

The claims in the new copy were checked against the code. In particular, every lookup result carries cache_hit, for both domain and IP lookups.

Not in this PR

  • The hero, the fan-out diagram, the plans, and the rest of the page are unchanged.
  • The v1.1.2 version and date in the changelog are a placeholder for whatever the release is cut as.

Verify

make verify passed: gofmt, vet, lint on new findings (0 issues), unit tests with -race, integration tests. The page was also checked in a browser at desktop and phone widths against the local stack.

Assisted-by: Claude Fable 5.2

Summary by CodeRabbit

  • Documentation
    • Updated the home page with a concise API description, domain and IP reference links, and information about unified results, REST/JSON automation, and cache freshness.
    • Removed the lookup coverage lists and sample request/response from the home page. The fan-out diagram remains an illustrative, non-exhaustive example.

The Product section listed every lookup for domains and for IPs and showed
a request with its response. That is the docs' job, and the docs are one
link away on the API's own hostname. It also made the home page a second
place a new lookup had to be added, which is exactly what the fan-out
diagram's "and more" was written to avoid.

The section now says what the API is for: the pitch, and three short
reasons (one place to ask, made for automation, clear about freshness).
Each claim was checked against the code; every lookup result, for domains
and for IPs, carries cache_hit. The links to the domain and IP references
stay.

With the list gone, a new lookup changes nothing on this page, so the
adding-features checklist no longer sends anyone here, and the docs-pages
rule says not to add reference material back.

Assisted-by: Claude Fable 5.2
@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The home page replaces its lookup lists and request/response sample with API-focused content. Related implementation notes, feature guidance, decision records, and the changelog are updated.

Changes: Home page content update

Layer / File(s) Summary
Home page product content
internal/handler/home.html, internal/handler/home.go
The product section now describes the API, links to domain and IP references, and lists unified results, REST/JSON automation, and cache freshness. Styles for the removed coverage lists and code sample are replaced. The handler comment describes the page’s content and shared data.
Documentation and release guidance
.claude/rules/docs-pages.md, .claude/skills/adding-features/SKILL.md, docs/decisions.md, internal/handler/changelog.yaml
The docs-pages rule and feature checklist no longer require a home-page lookup list. The decision record and v1.1.2 changelog describe the page’s updated content.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related issues

  • Security-Accelerated/intelligence-api#136 — Its endpoint documentation list aligns with this PR’s removal of the home page from the required lookup-update checklist. This PR does not implement the issue’s encryption endpoint.

Possibly related PRs

Merge Risk: Minimal · up to b6081

This change replaces the home page's lookup lists and sample request/response with a short description of the API, and updates the related guidance and changelog. It carries no meaningful merge risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the main change: the home page now describes the Intelligence API instead of documenting its lookups. The raw summary confirms that the lookup lists and request/response samples were r…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the main change: the home page now describes the Intelligence API instead of documenting its lookups. The raw summary confirms that the lookup lists and request/response samples were replaced with a short product description, and that the checklist and decision records were updated to match. The title is specific, short, and accurate.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between a27983c and b608161.

Files selected for processing: 6

  • .claude/rules/docs-pages.md
  • .claude/skills/adding-features/SKILL.md
  • docs/decisions.md
  • internal/handler/changelog.yaml
  • internal/handler/home.go
  • internal/handler/home.html

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@jasonnorch

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@jasonnorch
jasonnorch merged commit 7b524cb into main Nov 12, 2026
3 checks passed
@jasonnorch
jasonnorch deleted the feat/home-product-copy branch November 12, 2026 20:04
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