Skip to content
This repository has been archived by the owner on Jan 9, 2025. It is now read-only.

fix(docs): fix tasks.json inconsistent issue #381

Merged
merged 1 commit into from
Sep 30, 2024

Conversation

pinglin
Copy link
Member

@pinglin pinglin commented Sep 28, 2024

Because

  • there are many wording inconsistency issue in the tasks.json files.
  • duplicated instillUIOrder value causes the generated README.mdx inconsistent

This commit

  • fix the issues

Copy link
Collaborator

@jvallesm jvallesm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍 Thanks for spotting this!

@@ -227,7 +227,7 @@
"reference",
"template"
],
"title": "System message",
"title": "System Message",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: we should either document that titles must be title-cased in the contribution guidelines, or use the titleCaseWithArticles function in the template to unify the titles across the documents. If we don't care particularly about the JSON definition, I'd go with the second option.

@jvallesm jvallesm merged commit 63f4703 into main Sep 30, 2024
9 checks passed
@jvallesm jvallesm deleted the pinglin/fix-tasks-json-consistentcy branch September 30, 2024 09:03
jvallesm added a commit to instill-ai/pipeline-backend that referenced this pull request Oct 18, 2024
Because

- We relied on writing property titles with Title Case manually (e.g.
instill-ai/component#381,
instill-ai/component#361).

This commit

- Uses Title Case for property titles, too
- Extends lowercase dictionary
- Extends uppercase dictionary
- Respects capitalization of lowercase words if at the end of the title
- Respects capitalization of uppercase words if pluralized
- Adds unchanged words
- Moves dash (-) and underscore (_) replacement to anchor generation
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants