You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
So you asked for feedback on the setup process, and I thought some updates to the documentation might help other developers get set up. There is a tonne of awesome information in this repo, but it seems to have grown organically over time, so it's not necessarily the most organized.
There were two goals I had in mind for this pull request:
Make the README more of a sales pitch: "this is what fastlane is, this is why it's useful, this is how to install it, and here's where to go for more information."
Make the documentation easy to find, read, and reference.
I made some major changes to accomplish these goals:
Moved the documentation into a new /docs directory.
Moved a lot of the README into the /docs/README.md file, which is parsed by GitHub when you look at that directory.
Moved a lot of the README into other, more specific markdown files in the /docs directory.
Reorganized the Actions.md file to group all the actions into one of several categories: Building, Testing, Deploying, Modifying Project, Developer Portal, Using git, and Notifications. Keeping all of these straight was actually one of the biggest challenges for me when I was setting up fastlane, so hopefully this makes things easier.
There're also some smaller things I changed throughout, like consistently ending lists with periods, consistent capitalization, and consistent use of H1, H2, H3 in markdown files. I almost certainly missed some of these, but it's a start.
This is just an idea of how things could be β really looking forward to hearing your feedback. If you like something, we can more more in that direction. If you don't like something, we can change it.
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
None yet
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
So you asked for feedback on the setup process, and I thought some updates to the documentation might help other developers get set up. There is a tonne of awesome information in this repo, but it seems to have grown organically over time, so it's not necessarily the most organized.
There were two goals I had in mind for this pull request:
I made some major changes to accomplish these goals:
/docs
directory./docs/README.md
file, which is parsed by GitHub when you look at that directory./docs
directory.Actions.md
file to group all the actions into one of several categories: Building, Testing, Deploying, Modifying Project, Developer Portal, Using git, and Notifications. Keeping all of these straight was actually one of the biggest challenges for me when I was setting up fastlane, so hopefully this makes things easier.There're also some smaller things I changed throughout, like consistently ending lists with periods, consistent capitalization, and consistent use of H1, H2, H3 in markdown files. I almost certainly missed some of these, but it's a start.
You can preview any changes on my fork.
This is just an idea of how things could be β really looking forward to hearing your feedback. If you like something, we can more more in that direction. If you don't like something, we can change it.