api-clients-automation icon indicating copy to clipboard operation
api-clients-automation copied to clipboard

Published 20 hours ago • verified publisher icon algolia

docs: update contribution guideline

Open kai687 opened this issue 9 months ago • 2 comments

🧭 What and Why

This PR updates the guidelines for writing long descriptions. Essentially, don't use Markdown in the first sentence/paragraph in the descriptions.

The Algolia CLI uses the Search API spec to generate flags from the API parameter/index settings. The help text is generated from the first sentence of the description key.

It looks better on the command line if the help text doesn't contain Markdown.

For the most part, I already updated the specs with that in mind. There are some Markdown links, but they will be automatically removed when generating the flags and help text.

kai687 avatar May 03 '24 12:05 kai687

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch. You can still access the code generated on main via this commit.

algolia-bot avatar May 03 '24 12:05 algolia-bot

🚀 Deployed on https://6634de1dddadb7202e8786f1--api-clients-automation.netlify.app

github-actions[bot] avatar May 03 '24 12:05 github-actions[bot]

@millotp could you merge this for me please? I don't have permissions.

kai687 avatar May 08 '24 09:05 kai687