Skip to content

Adding all the docs changes to match command data and setup#112

Merged
wolfo951 merged 2 commits intomainfrom
wolfo951/generated-docs-from-command
Apr 18, 2025
Merged

Adding all the docs changes to match command data and setup#112
wolfo951 merged 2 commits intomainfrom
wolfo951/generated-docs-from-command

Conversation

@wolfo951
Copy link
Copy Markdown
Contributor

These changes came from the auto-generated docs command. This will be the only way to generate command docs in the future.

Comment thread docs/auth/info.md Outdated
Copy link
Copy Markdown
Contributor

@roopksaini roopksaini left a comment

Choose a reason for hiding this comment

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

Overall, this is looking good. The main thing I am seeing is re-ordering of options. From a usability perspective, we definitely want to be mindful of which options we present first for each command. Having iTwin and iModel IDs closer to the bottom (which seems to have happened for many commands) can have pros and cons. If people are using context / env variables, this can be helpful to directly engage with the specific options of a particular command. On the other hand, it feels natural to present the most fundamental ids closer to the top, since they indicate the entity we are working with.

In either case, we want to follow a consistent pattern.

Comment thread docs/imodel/connection/create.md
Comment thread docs/imodel/connection/sourcefile/add.md
Comment thread docs/imodel/connection/sourcefile/update.md
Comment thread docs/imodel/populate.md
@wolfo951
Copy link
Copy Markdown
Contributor Author

Overall, this is looking good. The main thing I am seeing is re-ordering of options. From a usability perspective, we definitely want to be mindful of which options we present first for each command. Having iTwin and iModel IDs closer to the bottom (which seems to have happened for many commands) can have pros and cons. If people are using context / env variables, this can be helpful to directly engage with the specific options of a particular command. On the other hand, it feels natural to present the most fundamental ids closer to the top, since they indicate the entity we are working with.

In either case, we want to follow a consistent pattern.

@roopksaini The reordering currently is done alphabetically by the flag's name, with the exception of giving priority to the required flags. Having it in alphabetical order makes sense, as it provides an expectation when the user is searching for something in the possible options.

@roopksaini
Copy link
Copy Markdown
Contributor

Overall, this is looking good. The main thing I am seeing is re-ordering of options. From a usability perspective, we definitely want to be mindful of which options we present first for each command. Having iTwin and iModel IDs closer to the bottom (which seems to have happened for many commands) can have pros and cons. If people are using context / env variables, this can be helpful to directly engage with the specific options of a particular command. On the other hand, it feels natural to present the most fundamental ids closer to the top, since they indicate the entity we are working with.
In either case, we want to follow a consistent pattern.

@roopksaini The reordering currently is done alphabetically by the flag's name, with the exception of giving priority to the required flags. Having it in alphabetical order makes sense, as it provides an expectation when the user is searching for something in the possible options.

Overall, this is looking good. The main thing I am seeing is re-ordering of options. From a usability perspective, we definitely want to be mindful of which options we present first for each command. Having iTwin and iModel IDs closer to the bottom (which seems to have happened for many commands) can have pros and cons. If people are using context / env variables, this can be helpful to directly engage with the specific options of a particular command. On the other hand, it feels natural to present the most fundamental ids closer to the top, since they indicate the entity we are working with.
In either case, we want to follow a consistent pattern.

@roopksaini The reordering currently is done alphabetically by the flag's name, with the exception of giving priority to the required flags. Having it in alphabetical order makes sense, as it provides an expectation when the user is searching for something in the possible options.

Ok that makes sense.

@wolfo951 wolfo951 merged commit 610fb68 into main Apr 18, 2025
11 checks passed
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

Successfully merging this pull request may close these issues.

3 participants