Docs: Adding an index and clarifying suggested usage #116
Conversation
This file contains 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
This PR does a couple of things: 1. Rewords the intro paragraph a bit to be slightly less technical 2. Adds a table of contents 3. Adjusts the installation instructions to promote the usage of the .phar approach over the dev dependency approach 4. Tweaks the `Usage` section to show a couple ways to execute Strauss 5. Removes the `dump-autoload` recommendation in favor of just recommending it always. Let me know if you'd like me to break these doc changes out into separate PRs so you can accept or deny them on their own!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR does a couple of things:
Usagesection to show a couple ways to execute Straussdump-autoloadrecommendation in favor of just recommending it always.Let me know if you'd like me to break these doc changes out into separate PRs so you can accept or deny them on their own! I definitely made some assumptions based on StellarWP's heavy usage of the tool 🕺