Diataxis categorization using anthropic to categorize by content. #4341
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
…into diataxis-llm
There was a problem hiding this comment.
-
Please expand the front-matter check to require a category. It's no good adding if in 6 months all new pages don't have it. I need to do the same for the keyword tagging.
-
I'd ask to please go through and check manually as well. Just a 10 minute scan through these and I can see many incorrectly tagged pages e.g.
docs/cloud/changelogs/24_06.mdtagged asexplanationbutdocs/cloud/changelogs/24_08.mdis tagged asreference. -
Let's have categories for
landing page,changelog, they seem like distinct docs. Anything else you can think of that feels like a distinct category? -
The difference between tutorial and how-to guide applied to ClickHouse docs is not clear to me (even after reading https://diataxis.fr/tutorials-how-to/). I wonder if just
guidedoesn't make more sense for our docs. We can always further refine with time. If you agree, just do a search and replace through the files to fix. Index.md files should be landing pages by convention.
| @@ -5,5 +5,6 @@ slug: /whats-new/changelog/ | |||
| sidebar_position: 2 | |||
| sidebar_label: '2025' | |||
| title: '2025 Changelog' | |||
| doc_type: 'reference' | |||
There was a problem hiding this comment.
| doc_type: 'reference' | |
| doc_type: 'changelog' |
docs/_snippets/_tabs.md
Outdated
| @@ -1,5 +1,6 @@ | |||
| --- | |||
| sidebar_label: Tabs Sample | |||
| doc_type: 'how-to' | |||
There was a problem hiding this comment.
I think we can delete this file honestly
docs/about-us/about-faq-index.md
Outdated
| @@ -2,6 +2,7 @@ | |||
| title: 'FAQ' | |||
| slug: /about-us/faq | |||
| description: 'Landing page' | |||
| doc_type: 'reference' | |||
There was a problem hiding this comment.
| doc_type: 'reference' | |
| doc_type: 'landing page' |
| @@ -5,6 +5,7 @@ sidebar_position: 50 | |||
| description: 'Understand what makes ClickHouse stand apart from other database management systems' | |||
| title: 'Distinctive Features of ClickHouse' | |||
| keywords: ['compression', 'secondary-indexes','column-oriented'] | |||
| doc_type: 'reference' | |||
There was a problem hiding this comment.
| doc_type: 'reference' | |
| doc_type: 'explanation' |
docs/about-us/index.md
Outdated
| @@ -2,6 +2,7 @@ | |||
| slug: /about | |||
| title: 'About ClickHouse' | |||
| description: 'Landing page for About ClickHouse' | |||
| doc_type: 'reference' | |||
There was a problem hiding this comment.
| doc_type: 'reference' | |
| doc_type: 'landing page' |
| @@ -6,6 +6,7 @@ title: 'Use JSON where appropriate' | |||
| description: 'Page describing when to use JSON' | |||
| keywords: ['JSON'] | |||
| show_related_blogs: true | |||
| doc_type: 'reference' | |||
There was a problem hiding this comment.
| doc_type: 'reference' | |
| doc_type: 'how-to' |
docs/best-practices/index.md
Outdated
| @@ -4,6 +4,7 @@ keywords: ['Cloud', 'Primary key', 'Ordering key', 'Materialized Views', 'Best P | |||
| title: 'Overview' | |||
| hide_title: true | |||
| description: 'Landing page for Best Practices section in ClickHouse' | |||
| doc_type: 'reference' | |||
There was a problem hiding this comment.
| doc_type: 'reference' | |
| doc_type: 'landing page' |
…ses. docs retyped
Summary
Adding doc_type to frontmatter of docs to enable diataxis categorization to be utilized for search and general organization.
Checklist