Simplify usage documentation #61
Merged
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
rogerluan
requested changes
Jun 8, 2024
README.md
Outdated
|
|
||
| ### Environment File | ||
|
|
||
| The environment(.env) file contains the actual secrets for each environment. While config file declares the keys, they are assigned encrypted values from this file. |
There was a problem hiding this comment.
These actually aren't required, and it's advised that no one commits them to git 😅 I'll add a note about this!
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.
While Arkana is a super handy tool, I found the documentation tricky to navigate when getting started.
I've created a basic usage/quickstart guide to help users get up and running quickly, leaving more advanced options for other sections. I believe this will help many users understand Arkana without being overwhelmed by the customizations it offers.
I'm open to feedback and would love to hear your thoughts on this.