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 comment included in the starter index.md #6916

Merged
merged 3 commits into from Apr 10, 2018

Conversation

Projects
None yet
5 participants
@ashmaroli
Member

ashmaroli commented Apr 9, 2018

A bit verbose but I guess it gets the message across with clarity.

@ashmaroli ashmaroli added this to the v3.8.0 milestone Apr 9, 2018

@ashmaroli ashmaroli requested review from DirtyF and oe Apr 9, 2018

# You don't need to edit this file, it's empty on purpose.
# Edit theme's home layout instead if you wanna make some changes
# See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults
# This file is empty because by default, the "content" is adequately realised

This comment has been minimized.

@oe

oe Apr 9, 2018

Member

I feel like this line is just going to confuse newcomers even more. What about replacing this with the original You don't need to edit this file, it's empty on purpose or some variation of it? If a user wants more information, they can look at the URL provided later on.

This comment has been minimized.

@ashmaroli

ashmaroli Apr 9, 2018

Member

I specifically want to do away with You don't need to edit this file, it's empty on purpose. It sounds like we're imposing something on the user..

This comment has been minimized.

@DirtyF

DirtyF Apr 9, 2018

Member

I'd like to keep it simple.

---
Feel free to add custom Front Matter to this file. 

To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
---

This comment has been minimized.

@ashmaroli

ashmaroli Apr 9, 2018

Member

I like zis.. 👍

# generated "index.html". You may also alter this front matter block itself
# if you'd like to, Jekyll won't mind.
#
# Checkout the following URL for information on customizing layouts and other

This comment has been minimized.

@oe

oe Apr 9, 2018

Member

should be "Check out"

# if you'd like to, Jekyll won't mind.
#
# Checkout the following URL for information on customizing layouts and other
# files bundled inside a theme-gem:

This comment has been minimized.

@oe

oe Apr 9, 2018

Member

"theme-gem" shouldn't be separated by dashes

ashmaroli added some commits Apr 9, 2018

@DirtyF

DirtyF approved these changes Apr 9, 2018

😌

@oe

oe approved these changes Apr 9, 2018

LGTM 👍

@influentialcode

This comment has been minimized.

influentialcode commented Apr 10, 2018

Thanks for the change. I think this is a good improvement and will certainly help.

@DirtyF

This comment has been minimized.

Member

DirtyF commented Apr 10, 2018

@jekyllbot: merge +minor

@jekyllbot jekyllbot merged commit 748051f into jekyll:master Apr 10, 2018

2 checks passed

WIP ready for review
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details

@ashmaroli ashmaroli deleted the ashmaroli:index-comment branch Apr 10, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment