Cleanup Documentation - Githubissues

bitrise-steplib / steps-xcode-build-for-simulator

MIT License

4 stars 18 forks source link

Cleanup Documentation #35

Closed hisaac closed 2 years ago

hisaac commented 2 years ago

Checklist

[x] I've read and followed the Contribution Guidelines
[x] step.yml and README.md is updated with the changes (if needed)

Version

Requires a MAJOR/MINOR/PATCH version update

Context

This change just updates the documentation in the step.yml file to better match our determined style.

Changes

Added .vscode to the .gitignore
Slimmed down the step's description to only include mention of commonly modified inputs, rather than descriptions of every input.
Updated some input titles and descriptions.

Investigation details

I met with a member of the tech writers team to learn more about how best to document steps, and will have them review this PR prior to opening it.

hisaac commented 2 years ago

Thanks for all the good suggestions @zoltan-baba! I believe I've addressed them all in https://github.com/bitrise-steplib/steps-xcode-build-for-simulator/pull/35/commits/aab926a0ff96f00f7561305ceec68ad360bb0edb. Let me know if you see anything else.

hisaac commented 2 years ago

@ofalvai I've updated the input title/summary/description info to match the conventions you sent me in https://github.com/bitrise-steplib/steps-xcode-build-for-simulator/pull/35/commits/6bf397c8663023c50732594cf07d368bac19df25 👍