docs: fix discrepancies between docs and latest implementation#81
Conversation
Audit of docs against ../formono (features, API, MCP, CLI, SDK, data,
security, integrations) and fixes for inaccurate or missing content.
MCP
- Document Scale/Enterprise plan requirement + 403 troubleshooting
- Correct tool table to the real allow-list (drop wallet_profiles,
top_custom_events; rename top_sources_metrics -> top_sources; add
missing tools); group top_* tools together
- lifecycle/retention/frequency are first-class tools, not SQL-only
API
- Add Get Contract page (GET /v0/contracts/{chain}/{address}) + nav
Events / SDK
- Fix version "1" -> "0"; add transaction reverted status
- Restore flattened function args (function_args is emitted both nested
and flattened) + explain the behavior
- Move address/user_id to top level in connect/disconnect/chain/
signature/identify samples
- Add paid-attribution click IDs; fix mobile network_* context fields
- Remove non-existent signatureHash from web SDK example
- Refresh stale SDK versions; reframe page-event example to a DeFi flow
Features
- Reframe Funnels/Flows/Retention as chart types (not nav pages);
rename "User Flow" chart -> "Flow"
- "Ask AI" -> "Ask Formo" across features and guides
- Audience Insights / Segments live on the Users page
- Alerts: webhook/Slack only (no Telegram/Email); User alerts gated
- Remove fabricated behavioral wallet labels; use real label categories
- Holdings tab -> Apps/Tokens
Data / Chains / Security / Integrations
- Remove unimplemented linear (multi-touch) attribution
- Catalog: real columns/types, drop non-existent chains/pages tables,
add wallet_profiles_labels
- Enable contract events for Blast/Kaia/Mode/Mode Testnet/Monad Testnet;
add Katana
- Roles: add BI-token + audit-log permissions; SSO: any SAML 2.0 IdP;
add audit log mention
- Integrations: document Slack/webhook/email via Alerts
Web SDK examples: remove Blocknative/Porto/Farcaster cards; normalize
Crossmint/Openfort/Angular labels to with-N format
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request extensively updates the documentation to reflect product rebranding (renaming 'Ask AI' to 'Ask Formo'), navigation adjustments, and the introduction of Model Context Protocol (MCP) plan requirements. Technical updates include moving 'address' and 'user_id' to top-level event properties, adding ad click identifiers, and reorganizing wallet profile sections. Feedback identifies a contradiction regarding email alert support and highlights a loss of descriptive context in several SDK examples. A suggestion was also provided to improve the logical grouping of tools within the MCP documentation.
| |:---------|:----------|:--------| | ||
| | Slack | ✅ | Posts formatted event cards to a Slack channel via an incoming webhook URL | | ||
| | Webhooks | ✅ | Sends matched events as JSON to your endpoint. | | ||
| | Email | ✅ | Sends alert notifications to one or more email recipients | |
There was a problem hiding this comment.
This entry contradicts the PR description and changes in other files (e.g., features/product-analytics/alerts.mdx and guides/funnels.mdx) which indicate that Email support for Alerts has been removed. If Email is indeed not supported, this row should be removed to avoid misleading users.
| href="https://github.com/getformo/examples/tree/main/with-crossmint" | ||
| > | ||
| Next.js + Crossmint embedded smart wallets. Manual Formo instrumentation (no EIP-1193 / wagmi). | ||
| examples/with-crossmint |
There was a problem hiding this comment.
The descriptive text for the Crossmint example has been replaced with just the directory path. This results in a loss of helpful context for users (e.g., mentioning Next.js and manual instrumentation). Consider restoring the descriptive text.
Next.js + Crossmint embedded smart wallets. Manual Formo instrumentation (no EIP-1193 / wagmi).
| href="https://github.com/getformo/examples/tree/main/with-openfort" | ||
| > | ||
| Vite + React + Openfort with Shield encryption sessions (Express backend) and an Aave supply/withdraw demo. | ||
| examples/with-openfort |
There was a problem hiding this comment.
The descriptive text for the Openfort example has been replaced with just the directory path. Consider restoring the original description to maintain documentation quality.
Vite + React + Openfort with Shield encryption sessions (Express backend) and an Aave supply/withdraw demo.
| href="https://github.com/getformo/examples/tree/main/with-farcaster" | ||
| > | ||
| examples/with-farcaster | ||
| examples/with-angular |
There was a problem hiding this comment.
The descriptive text for the Angular example has been replaced with just the directory path. Consider restoring the original description.
Angular 21 + bare EIP-1193 + viem. Uses the framework-agnostic SDK core.
| | `top_events` | View most common events | | ||
| | `top_custom_events` | View custom tracked events | | ||
| | `event_timeseries` | Event counts over time | | ||
| | `lifecycle` | New, returning, resurrected, and dormant users | | ||
| | `retention` | User retention by cohort | | ||
| | `frequency` | How often users return | | ||
| | `top_pages` | Analyze page performance | | ||
| | `top_sources_metrics` | Attribution and traffic sources | | ||
| | `top_sources` | Attribution and traffic sources | | ||
| | `top_locations` | Geographic distribution | | ||
| | `top_wallets` | Most active wallets | | ||
| | `top_chains` | Activity by blockchain | |
There was a problem hiding this comment.
The PR description mentions grouping top_* tools together, but top_events (line 85) is currently separated from top_pages (line 90) and the subsequent top_* tools by other analytics endpoints. Moving top_events down to be adjacent to top_pages would improve the logical grouping and consistency with the PR's intent.
Broken links/anchors (verified all internal links + heading anchors now resolve, 0 broken): - intro: /guides/ -> /guides/onchain-attribution - custom-events: /features/wallet-intelligence -> .../overview; /sdks/web#custom-events -> #track-events - sdks (web/server/mobile): /data/events#events-api -> /data/events/overview#events-api - sdks/web + install: fix #react--nextjs / #websites / #privy / #react-&-next-js-without-wagmi anchors; install method links now point to the real /sdks/web#... headings - metrics: custom-events#tracking-revenue -> #step-3-...; track comma anchor - wallet-intelligence/overview, security/overview: drop dead anchors Typos: - metrics: "leave" -> "leaves"; "a search engines" -> "a search engine" - what-we-collect: "the their time zone" -> "their time zone" - chains: "on Ethereum on all major EVM chains" -> "and all major EVM chains" Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 participant
Audit of docs against ../formono (features, API, MCP, CLI, SDK, data, security, integrations) and fixes for inaccurate or missing content.
MCP
API
Events / SDK
Features
Data / Chains / Security / Integrations
Web SDK examples: remove Blocknative/Porto/Farcaster cards; normalize Crossmint/Openfort/Angular labels to with-N format
Need help on this PR? Tag
@codesmithwith what you need. Autofix is disabled.