docs: audit metadata, SEO descriptions, and sidebar titles#13
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: audit metadata, SEO descriptions, and sidebar titles#13mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
… pages Generated-By: mintlify-agent
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audited all 373 MDX pages for SEO, metadata, style, and structural issues. This PR fixes everything that could be resolved automatically without touching technical content; items that need human judgment are listed at the bottom.
Automatic fixes applied (63 files)
Broken descriptions
Three pages had
description: "import HistoricalFact from './_gpv2.md'"(a leftover import statement, not a real description). Rewrote with proper SEO descriptions and addedsidebarTitle:cow-protocol/reference/contracts/core/allowlist.mdxcow-protocol/reference/contracts/core/settlement.mdxcow-protocol/reference/contracts/core/vault-relayer.mdxSeveral other descriptions had broken link artifacts (e.g.
"A simple (TWAP) trade may be thought of as smaller trades...","leveraging the to execute...") — left over from removed markdown links. Rewrote these to coherent SEO descriptions on:cow-amm/explanation/the-problem-of-lvr.mdxcow-protocol/explanation/architecture/solver-engine.mdxcow-protocol/explanation/benefits/trade-any-intent.mdxcow-protocol/explanation/how-it-works/flow-of-an-order.mdxcow-protocol/explanation/introduction/intents.mdxcow-protocol/explanation/order-types/cow-hooks.mdxcow-protocol/explanation/order-types/programmatic-orders.mdxcow-protocol/reference/contracts/periphery/composable-cow.mdxcow-protocol/reference/contracts/programmatic/twap.mdxcow-protocol/reference/core/auctions.mdxcow-protocol/reference/core/auctions/ebbo-rules.mdxcow-protocol/reference/core/auctions/rewards.mdxcow-protocol/reference/core/intents/hooks.mdxcow-protocol/reference/core/signing-schemes.mdxcow-protocol/reference/core/tokens.mdxcow-protocol/tutorials/cow-amm-deployer.mdxcow-protocol/tutorials/cow-explorer/address.mdxcow-protocol/tutorials/cow-explorer/batch-auction.mdxcow-protocol/tutorials/cow-explorer/order.mdxcow-swap/widget/params.mdxcow-protocol/explanation/flash-loans/integrators.mdxcow-protocol/explanation/order-types/pay-debt-flash-loans.mdxAdded missing
description(12 pages)All pages without a description (excluding
snippets/*, which are partials) now have a 50–160 character SEO-friendly description mentioning CoW Protocol/CoW Swap/CoW AMM where relevant:cow-amm/explanation/how-cow-amms-work.mdxcow-amm/tutorials/cow-amm-for-solvers.mdxcow-protocol/explanation/architecture/autopilot.mdxcow-protocol/howto/solvers/onboard.mdxcow-protocol/howto/solvers/routes_integration.mdxcow-protocol/reference/core/definitions.mdxcow-protocol/reference/sdks/cow-sdk.mdxcow-swap/hooks/hook-dapp.mdxgovernance.mdxgovernance/explanation/process.mdxgovernance/reference/cip-template.mdxgovernance/reference/fees.mdxgovernance/reference/partner-fee.mdxExpanded too-short descriptions (<50 chars)
changelog.mdx,mevblocker.mdxcow-py/api/contracts.mdx,cow-py/api/subgraph.mdx,cow-py/installation.mdxhooks-trampoline/api/errors.mdxwatch-tower/advanced/storage.mdx,watch-tower/deployment/dappnode.mdx,watch-tower/deployment/docker.mdxTrimmed overly long descriptions
Brought several descriptions above 200 characters back into the 130–160 SEO sweet spot, including:
cow-amm.mdx,cow-protocol/explanation/architecture/driver.mdx,cow-protocol/howto/cow-explorer.mdx,cow-protocol/reference/core/auctions/accounting.mdx,governance/explanation/mission.mdx,governance/explanation/token.mdx.Added
sidebarTitleto long titles (>30 chars)All 17 pages with titles over 30 characters now have a concise
sidebarTitle, including BFF services, CoW AMM, the CoW Hook deployer, FCBA, solver tutorials, ERC-1271 signing, DCA TWAP, and the GPv2 contract reference pages.Validation
mint validate✅mint broken-links✅ (no broken internal links)Items requiring human judgment (not changed)
Slightly long descriptions (161–202 chars)
The following pages have descriptions slightly above Google's 160-char cap. They read well and use no broken markup, so I left them alone — please review and trim if you want strict SEO compliance:
bff/services/api.mdx(172)composable-cow/introduction.mdx(168)cow-protocol/explanation/fee-model.mdx(202)cow-protocol/explanation/how-it-works/coincidence-of-wants.mdx(166)cow-protocol/explanation/how-it-works/how-intents-are-formed.mdx(193)cow-protocol/explanation/order-types/liquidations.mdx(190)cow-protocol/explanation/order-types/twap-orders.mdx(226)cow-protocol/howto/integrate/api.mdx(161)cow-protocol/howto/integrate/sdk.mdx(184)cow-protocol/overview.mdx(173)cow-protocol/reference/core/auctions/competition-rules.mdx(166)cow-swap/features.mdx(167)cow-swap/reference/custom-links.mdx(209)cow-swap/tutorials/native.mdx(242)cow-swap/tutorials/twap.mdx(190)cow-swap/widget/overview.mdx(210)governance/explanation/grants/grant-types.mdx(194)Code blocks without language identifiers (~220 occurrences)
A bulk grep found roughly 220 fenced code blocks across the docs that have no language tag. They span Solidity, JSON, TypeScript, plain output, and URLs, and require human review to tag correctly. The highest-density files are:
cow-protocol/reference/contracts/core/*.mdx(Solidity)cow-protocol/reference/contracts/periphery/composable-cow.mdx(Solidity, 16 blocks)cow-protocol/reference/contracts/periphery/eth-flow.mdx(Solidity)cow-protocol/reference/contracts/periphery/flashloans.mdx(Solidity)cow-protocol/howto/integrate/api.mdx(mix of JSON / shell / TS)cow-protocol/explanation/how-it-works/how-intents-are-formed.mdx(JSON / TS)bff/api-reference/*.mdx(URLs, JSON)composable-cow/api/*.mdxandcomposable-cow/order-types/*.mdx(Solidity)Recommended fixes:
https://...) astext.function,event,mapping,address public ...) assolidity.json.Diataxis & writing style
Most pages follow the diataxis quadrants correctly via the
explanation/,howto/,reference/,tutorials/folders. A few pages mix concerns and could be split or relocated:cow-protocol/howto/cow-explorer.mdxmixes explanation with how-to; consider moving the conceptual intro intoexplanation/.cow-protocol/tutorials/solvers/local_test.mdxopens with an explanatory disclaimer ("CoW Protocol infrastructure is a lot of services running together…") that should be replaced with prerequisites and the first step.governance/explanation/token.mdxreads more like marketing copy than an explanation; lead with the answer ("COW is the governance token of CoW DAO — used to vote on CIPs and align stakeholders.").Snippets without frontmatter (expected, no fix)
snippets/*.mdxfiles are partials imported into other pages, so the absence oftitle/descriptionis correct.