Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve documentation: add configuration examples #34

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

adamjanicki2
Copy link
Contributor

@adamjanicki2 adamjanicki2 commented Apr 28, 2024

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

Copy link

netlify bot commented Apr 28, 2024

Deploy Preview for treecle ready!

Name Link
🔨 Latest commit 42481df
🔍 Latest deploy log https://app.netlify.com/sites/treecle/deploys/662fbb0e4834540008de6133
😎 Deploy Preview https://deploy-preview-34--treecle.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@LeaVerou LeaVerou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@adamjanicki2
Copy link
Contributor Author

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.

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 ?

@adamjanicki2 adamjanicki2 changed the title improve documentation: add simple examples improve documentation: add configuration examples Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants