shift-org / shift-org/shift-docs

theme: document how menus on site are built and how theme is used

Open
#56 1 comment 0 reactions 1 assignee View on GitHub

@stephaniecp is already working on this.

Since Dec 19, 2018.

enhancement help wanted
Dominant language
JavaScript
Stars
30
Forks
25
Avg merge
9m
Merged PRs (30d)
1

Description

@carrythebanner and I had some trouble debugging a collision in page names that causes hugo to error out like this:

Error: Error building site: "/Users/jhetrick/Documents/z_etc/shift-docs/site/content/pages/pedalpalooza.md:1:1": duplicate menu entry with identifier "Pedalpalooza" in menu "main"

We were at a bit of a loss to figure out:

  • what file was conflicting
  • why it mattered (the same-named files were in different directories and shouldn't have conflicted).

What this issue requests is:

  • an explanation of how the menu layout is created (we think it's largely based on frontmatter that exists in only SOME markdown files?). I'd suggest this belongs somewhere in the docs/ directory so people follow the intended pattern when creating new content. Maybe includes a "best practices for using/modifying this theme" too?
  • some suggestions of how to debug problems like that. We never actually "solved it" - just worked around by renaming his page to something different.

Thanks for your help!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.