improve documentation: add configuration examples#34
Open
adamjanicki2 wants to merge 2 commits intomainfrom
Open
improve documentation: add configuration examples#34adamjanicki2 wants to merge 2 commits intomainfrom
adamjanicki2 wants to merge 2 commits intomainfrom
Conversation
✅ Deploy Preview for treecle ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
LeaVerou
requested changes
Apr 29, 2024
Member
LeaVerou
left a comment
There was a problem hiding this comment.
I think the examples section should have usage examples, not configuration examples. The defaults should already work with a good variety of trees. You could then have a section on Configuration lower down.
Contributor
Author
Got it; I'll move these down into a separate configuration section, and then make a follow-up PR to add the usage examples section so then this PR isn't massive. Does that sound ok with you @LeaVerou ? |
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
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.
Part of #33
This PR contains a few simple examples of how to configure Treecle with custom configs. A follow-up PR will handle all usage examples