docs(seo): improve frontmatter descriptions and add OpenGraph metatags#136
Open
docs(seo): improve frontmatter descriptions and add OpenGraph metatags#136
Conversation
Improve AI discoverability of docs.arklex.ai by enriching page frontmatter descriptions (which feed Mintlify's auto-generated llms.txt) and adding OpenGraph/Twitter Card metatags to docs.json.
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
descriptionfields across 9 docs pages indocs/main/so the auto-generatedllms.txt(served by Mintlify) contains specific, ArkSim-branded descriptions instead of generic summariesog:site_name,og:type,og:description, andtwitter:cardmetatags todocs.jsonfor better social sharing and AI discoverabilityWhy
Mintlify auto-generates
llms.txtandllms-full.txtfrom page frontmatter. Several pages had vague descriptions that didn't mention ArkSim by name, weakening entity clarity for AI answer engines. These changes ensure that when AI models (ChatGPT, Perplexity, Claude, Google AI Overviews) crawl our docs, they get specific, useful descriptions of what each page covers.Pages updated
Test plan
docs.jsonis valid JSON (pre-commit hook checks this)docs.arklex.ai/llms.txtfor improved descriptions