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.

Sign up for GitHub

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

Jump to bottom

Create article title guidelines #2899

Open

guimachiavelli opened this issue Jul 4, 2024 · 0 comments

Labels

tooling and maintenance

Member

guimachiavelli commented Jul 4, 2024

Tentative guidelines:

Tutorials: general verbs, gerund. “Working with filters”, “Getting started with ranking rules”. (Exception: “Quick start”)
Guides: specific verb, simple present. “Configure Meilisearch at launch”, “Paginate tasks”
References: single word, preferably noun, infinitive if verb. “Indexes”, “Search”
Explanation: multiple words, preferably nouns, descriptive. “When to use API keys and the master key”, “What is multitenancy”, “Distinct attribute”

Main gist: verbs to indicate task-oriented material, nouns to indicate understanding-oriented material.

guimachiavelli changed the title ~~Create article titling guidelines~~ Create article title guidelines

guimachiavelli added the tooling and maintenance label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment