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

Update site template configuration file with link to config options docs #563

Merged
merged 1 commit into from
May 25, 2022
Merged

Update site template configuration file with link to config options docs #563

merged 1 commit into from
May 25, 2022

Conversation

andrewmcodes
Copy link
Contributor

This is a 🙋 feature or enhancement.

Summary

This commit adds a link to the configuration options docs directly into the default bridgetown.config.yml. This will make navigating to the docs quicker and will also increase discoverability of those options for folks getting started with Bridgetown.

Context

I often need to reference the configuration options docs when updating my site config. Typically, I have to navigate to the Bridgetown site, and then search/find the link for the configuration options, which takes several clicks and can break my concentration. This change will also ensure that the options are easily discoverable in case someone has trouble finding them on the website.

Not a necessity, but it would be nice to have and provide a smoother DX after running bridgetown new.

Adds a link to the configuration options documentation in the default `bridgetown.config.yml` to make it easier to see all available configuration options without having to search for it.
@andrewmcodes andrewmcodes changed the title chore: update site template config Update site template configuration file with link to config options docs May 25, 2022
@jaredcwhite
Copy link
Member

@andrewmcodes Makes total sense, and it'll also add more impetus to keep that docs page updated regularly.

@jaredcwhite jaredcwhite merged commit a02293b into bridgetownrb:main May 25, 2022
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