New Gridcoin.us Wiki Pages & New Table of Contents Feature

in Gridcoin (GRC)3 years ago (edited)

Summary

There are three new wiki pages and a new table of contents sidebar for every wiki page.

New Pages

Table of Contents

Every page now has a sidebar on the right (or on the bottom for mobile which may be moved in the future) that you can click to view.

image.png
Example Table of Contents from the UTXO page

What Did I Learn/Relearn

Adding a table of contents things in a sidebar was harder than I thought. At first I thought it was going to be something fairly simple.

I had to do a really less than ideal method to generate the table of contents. Kramdown (the markdown engine that this site uses) has a nice table of content generator, but it assumes you want to add it directly to the page. I instead wanted to add it to a side bar. What I ended up doing was rendering every page twice and use that table of contents part in the second version and then stripping out everything but that table.

Scrapping bad diagrams/text/whatever and starting over is helpful sometimes when you're stuck. While creating the diagram for the UTXO page, I had something that really failed to simply convey what I was trying to convey and just got way too complicated. Starting over helped a lot

Talking to others not familiar with what you want to convey can also help a lot. You can spot what you are missing and just trying to explain it to them verbally helps you crystalize what's important to mention. This helped with the UTXO page here and indirectly with the forks page from past explanations

More Information

More information about all changes can be found at the pull requests that added them:

https://github.com/gridcoin-community/Gridcoin-Site/pull/317 (new pages)

https://github.com/gridcoin-community/Gridcoin-Site/pull/315 (table of contents)

https://github.com/gridcoin-community/Gridcoin-Site/pull/318 (UTXO page correction)