zalando/restful-api-guidelines

Editorial: Uniform Layout and Naming of Hints, Remarks, Exceptions etc.

Open

#660 opened on May 18, 2021

View on GitHub
 (11 comments) (0 reactions) (1 assignee)CSS (1,984 stars) (356 forks)batch import
editorialenhancementhelp wanted

Description

We use different layout formats for standard guideline elements like 'Exception:', 'Hint:', 'Note:', 'Remark:', 'Example:', 'Tip', 'Reasoning:', 'Warning:', 'Important:', 'Caution:'. Additionally, the elements are partially redundant with unclear 'didactic purpose'. Let us reduce the elements to a minimal set with clear purpose and uniform layout. It will contribute to readability and efficient consumption by API builders. Examples:

Contributor guide

Tech stack
None
Domain
documentationcontent
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with RESTful API guidelinesKnowledge of Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue aims to standardize the layout and naming of editorial elements like hints, notes, and exceptions across the RESTful API guidelines. First, review the provided examples (e.g., #101, #116, #104, #114) to see current inconsistencies. Then, read through the comments for community suggestions on a minimal set of elements and uniform format. The work involves editing multiple Markdown files, each corresponding to a guideline rule. Identify all instances of these elements and propose a consistent naming convention (e.g., 'Note:', 'Warning:', etc.) and visual layout. No code changes are needed; focus on text and formatting. The repository's structure can be explored in the ` guidelines` directory.