Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

💡TinaDocs - Docs vs Documentation vs TinaDocs - Investigate naming #2735

Open
Marxoz opened this issue Jan 14, 2025 · 1 comment
Open
Assignees
Labels

Comments

@Marxoz
Copy link
Contributor

Marxoz commented Jan 14, 2025

🩸 Pain

It is difficult to distinguish between TinaDocs, Tina Documentation and docs, whatever that is.

@Marxoz Marxoz changed the title 💡Docs vs Documentation vs TinaDocs - Investigate naming 💡TinaDocs - Docs vs Documentation vs TinaDocs - Investigate naming Jan 14, 2025
@landonmaxwell landonmaxwell self-assigned this Jan 29, 2025
@landonmaxwell
Copy link
Contributor

landonmaxwell commented Jan 29, 2025

As we are wanting to focus on user generated documentation & starters:

  1. Use the format:
    Documentation Starters = Subdirectory (e.g. tina.io/documentation), this matches how product sites group their products and improves our SEO
    Internal Guides = Subdomain (e.g. docs.tina.io)

  2. Disambiguation & consistency of terms:
    Documentation (full word) = user generated documentation & starters
    Docs = internal guides (e.g can call it "docs.tina")

From the top 10 competitors in the documentation space:

  • (4/10) Documentation & Docs: had a clear focus on user generated documentation & starters
    All of these sites followed the format:
    Documentation Starters = Subdirectory (e.g. URL/documentation)
    Internal Guides = Subdomain (e.g. docs.URL)

  • (5/10) Docs Only (Internal Guides): did not have a clear distinction on user generated documentation & starters
    Most of these sites followed the format:
    Documentation Starters = ⚠️ Unclear / not obvious or easy to find
    Internal Guides = Subdirectory (e.g. URL/docs)

  • (1/10) Other: had a site error 😅 (apiDoc)

Image
Figure: TinaCMS Documentation Competitors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants