Site Updates

Recent updates

2022.05.27

  • Started Hugo with docsy theme proof of concept site with defaults running on localhost
  • Brainstormed desired end state for the short term:
    • Read what was possible + tinkered + brainstormed
    • Decided to disable “blog” functionality, and go “docs” (tree) only mode, which results in better consistency in the UI. (otherwise it’s possible to have tags associated with blogs and tags associated with docs, that are independent of each other which is a bad UX.)
    • I figured Site Updates can function as a change log posted on the site instead of hidden in a readme. + I can manually specify cronological order of updates/changes there, which was the only feature I wanted from the blog functionality.
    • Decided on this for top menu:
      • Home –> about GuydeScape
      • Browse Topics –> Topics in Tree View (Topics: Learn about X)
      • Browse Guydes –> Guydes in Tree View ()
      • Browse Tags –> Tag search (great for when things fall in multiple categories, but must exist in a primary location in the tree.)
      • Site Updates
      • Premium Content (future page that can link to courses, books, and other paid content)
      • Search
  • Changed the config.toml to config.yaml (took a while to figure out correct syntax.)
  • Wired the site up to match my desired end state (with placeholder text in some places)
  • Disabled & Removed some of the original default content & default home page
  • Got basic clientside search functionality to work (plan to replace in the distant future.)
  • Site style based customizations:
    • Added GS logo
    • Added favicon, browser tag icon, to the site
    • Changed the default blue color scheme to green
  • Figured out how to customize the side menu a bit; unfortunately, it’s customizability is limited / only offers global toggles to tweak how it works. At first I wanted to use collapseable sections simliar to kubernetes.io/docs, but then I realized that’s alot of clicking, so I switched the implementation detail to be similiar to how rancher docs work using side_menu_compact: true. It achieves a simliar effect, just with less clicking when navigating.
  • In the tree guydes work slightly different when clicked in that they create their own new tree, part of that was to test what customizations were possible, and I think it’d be useful to be able to focus on the content of a guyde when zoomed into a guyde. (This was possible by adding toc_root: true to a folder’s _index.md)

2022.05.28

  • Adding a Site Updates section
  • Posting to PoC to CloudFlare Pages

How updates are organized

  • KISS text file based Change log of updates will be posted here.
  • (Eventually when this page becomes big I’ll break out older updates into a seperate file)