Markdown File Naming Conventions and Content Formatting

This page describes the standard file naming convention and text-formatting guidelines to follow across all Choreo-related content to maintain consistency.

File naming convention

Markdown file names

Use meaningful file names and always specify the file name in kebab case or hyphen-separated style.

For example,

• get-started.md
• work-with-triggers.md

Try to keep the file name and the markdown content main title consistent. For example, If the file name is key-concepts.md, the markdown content main title would be Key Concepts.

Image names

Use meaningful image names and always specify the name in kebab case or hyphen-separated style.

For example,

• developer-portal.png
• logs-panel.png

Text-formatting guidelines

Element	Convention	Example
Field names and UI elements	Bold	Go to the APIs card and click Get Started.
User input values	Backticks	Enter hello as the URI pattern.
Code elements	Backticks	You can use the getQueryParamValue function of the request variable to read query parameter values that are passed.
Protocol names, HTTP verbs, HTTP status codes, and HTTP content-type values	Backticks	If a request is processed successfully, it responds to the client with an HTTP_OK.