Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

Documentation changes

This PR adds a GEO guide.

Part of https://linear.app/mintlify/issue/DOC-121/seogeo-best-practices


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful


- Content utility and comprehensive answers
- Structured, scannable information
- Direct answers to questions
Copy link
Contributor

Choose a reason for hiding this comment

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

more philosophical question — should we encourage people to have a FAQs page that has direct answers? this is a product question as well, like the community forum / support use case

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Historically, FAQ pages have been dismissed by tech writers since you can't ever know every question someone is going to ask and people didn't really search in full questions.

But now people are asking full questions of these tools, so FAQs might be better.

Kind of a frontier and a shift in best practice so I don't know what's actually going to perform best. Reflexively, I don't want to encourage FAQ pages, but they might now be way more valuable than they were in the past.

@ethanpalm ethanpalm merged commit d193a3f into main Jul 25, 2025
5 checks passed
@ethanpalm ethanpalm deleted the geo-guide branch July 25, 2025 18:22
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.

2 participants