search

vsoch / docsy-jekyll

A Jekyll version of the beautiful Docsy!
https://vsoch.github.io/docsy-jekyll/
Apache License 2.0
199 stars 142 forks source link

Reorganize the Getting Started page to reflect workflow #60

Closed mccurcio closed 2 years ago

mccurcio commented 3 years ago

Hi vsoch, I have several potential documentation issues that could be worked on and then tackled in small, simple steps. I want to outline several steps that I could work on with your approval.

  1. May I suggest changing the outline of the Getting Started page.
  2. (H1)Getting Started
  3. Add color to docsy-jekyll.png to highlight areas of interest.
  4. (H2)Prerequisites (change name from Development)
  5. (H3)Installing on OSX directions
  6. (H3)Install on Ubuntu procedure
  7. (H2)Install code base
  8. (H3) git on local harddisk
  9. (H3) or via GitHub starter template
  10. (H3) How to run jekyll server
  11. (H2) Changing config.yml
  12. (H3) Describe general steps
  13. Add Instructions to change _config.yml in .yml document
  14. Add additional note to _config.yml line 26 for clarity ...

With your guidance, I could work on these steps in order (one by one) or we could discuss broader changes.

I look forward to working on this with you, MCC

vsoch commented 3 years ago

@mccurcio I'd definitely be open to any changes that you might have - I can't give you a yes/no answer based on these bullets, but if you want to break them up into a piece size that is digestible for you to work on, I will be happy to review!

mccurcio commented 3 years ago

On the Getting Started/Customization ###config.yml section, there are several links that are broken. I am trying to contribute another pull request.

mccurcio commented 2 years ago

Hi V, I decided to rewrite sections in my copy of Docsy-Jekyll. Thank you for your time.