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 docs about pinned posts #99

Closed
4 tasks done
agarthetiger opened this issue Aug 11, 2020 · 2 comments
Closed
4 tasks done

Update docs about pinned posts #99

agarthetiger opened this issue Aug 11, 2020 · 2 comments
Labels
enhancement New feature or request inactive No activity

Comments

@agarthetiger
Copy link

Checklist

  • I have read the contributing guidelines.
  • There are no similar request on existing issues (including closed ones).
  • I have read the project progress and know the current progress of the project.
  • I was in the develop branch of the latest code.

Is your feature request related to a problem? Please describe

I followed the guide in the README and was trying to create my own content. I copied the frontmatter from a post from the original _posts folder in your repo. I didn't want to pin a post, so I changed the value to pin: false instead of removing this setting. I thought this would be the safer option but doing this causes the post to disappear from the homepage. There are no errors in the terminal running "bash tools/run.sh" but the homepage shows just a clock icon and an Invalid Date message.
Screenshot 2020-08-11 at 09 05 15

This sent me down a rabbithole debugging the date settings etc before I went back to the original repo and copied a post exactly to test (which worked) and then changed one setting at a time.

Describe the solution you'd like

Updating the documentation to specifically state indicate that the pin setting should be removed if you don't want to pin a page.

Describe alternatives you've considered

Setting pin: false in the frontmatter works like any other unpinned post, in the same way as omitting the pin setting does.

Additional context

I really love this theme and am especially impressed and pleased with how good the documentation has been to follow and get started with. I'm starting to open source some of my own projects and I am finding out how much time and effort goes into great documentation. Kudos for your time and effort, I really appreciate it.

@agarthetiger agarthetiger added the enhancement New feature or request label Aug 11, 2020
cotes2020 added a commit that referenced this issue Aug 11, 2020
@cotes2020
Copy link
Owner

Thank you for your suggestion, this issue is a bug in a sense. :)

@github-actions
Copy link

This issue is stale because it has been open 5 days with no activity. Remove stale label or comment or this will be closed in 2 days

@github-actions github-actions bot added the inactive No activity label Aug 18, 2020
cotes2020 added a commit that referenced this issue Sep 21, 2020
mattpopovich pushed a commit to mattpopovich/jekyll-theme-chirpy that referenced this issue Oct 3, 2020
cotes2020 added a commit that referenced this issue Oct 22, 2021
sanjidnet pushed a commit to sanjidnet/sanjidnet.github.io that referenced this issue Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request inactive No activity
Projects
None yet
Development

No branches or pull requests

2 participants