Skip to content
This repository has been archived by the owner on Apr 22, 2021. It is now read-only.

docs(readme): and gemlock plus instruction to setup #44

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mgan59
Copy link
Contributor

@mgan59 mgan59 commented Aug 28, 2020

Context

After having to lookup setup instruction twice decided it was time to document them into a readme for the time being till we replace the current site with a Hugo/Docsy version. So to issue #33 I decided to put the basic notes into a readme.

As we get the Hugo project going we should link the readme to the on-going new site work so that others can join and participate as well.

NOTE: we should wait to merge this till after we get #43 merged.

@mgan59 mgan59 added the documentation Improvements or additions to documentation label Aug 28, 2020
Copy link
Contributor

@jaredmorgs jaredmorgs left a comment

Choose a reason for hiding this comment

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

I can verify these are generic bundle instructions for building a gem-based static site. Thanks for taking the time to document them @mgan59

If you believe there is value in documenting the bundle and ruby version in the project, you can choose to leave them in the README.
Or to save maintenance, you can instruct folks to review the files before they begin developing the project locally, thereby removing the need to keep the README and build files in sync.

@mgan59 mgan59 force-pushed the add-setup-contributor-guide-to-readme branch from 171e5e2 to e8dee3e Compare November 18, 2020 22:49
@bwklein
Copy link
Member

bwklein commented Mar 27, 2021

Not relevant to the new Hugo site.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants