Skip to content
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.

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

🗃️ Replace integer keys with short semantic IDs #32

Open
shnizzedy opened this issue Feb 3, 2024 · 0 comments
Open

🗃️ Replace integer keys with short semantic IDs #32

shnizzedy opened this issue Feb 3, 2024 · 0 comments

Comments

@shnizzedy
Copy link
Member

"bronze": {
"type": "object",
"properties": {
"1": {

I don't love using integer keys here, because

  • the key doesn't have semantic relevance to the item
  • I think the sequence of these items within a tier is arbitrary, but numbering them implies otherwise
  • as the checklist evolves, we'd either end up with a sequence of numbers with gaps or reusing keys to mean different things across versions

#30 (comment)

The keys are a direct migration from the previous e.g.:

"id": "bronze_doc_1",

Which is now documentation.bronze.1.

But I agree that these could be semi-informative short IDs instead.

#30 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant