JacquesCarette
Wiki Cleanup
As part of my RA work, I will be going through the Drasil Wiki and checking what needs to be updated, etc. I'll post my initial findings here.
To start off, I compared the contents of the wiki folder and the sidebar to see when there were missing or dead references.
Missing from Sidebar
I wasn't able to find any links in /wiki/_Sidebar.md to any of the following pages in /wiki/. There's a chance they are in there, but I wasn't able to find them.
- File-Input-Patterns-Design-Discussion.md
-
GOOL-GProc Overview.md
- This was my fault, I forgot to add a link when I created the file in #3915. I will add it shortly.
- Getting-To-Know-Potential-Users-of-Drasil.md
- Nuggets.md
- Questions.md
- Reference-Design-and-Documentation.md
- What-If.md
Dead Links in Sidebar
-
Converting GOOL Classes into Struct Libraries for Procedural Languages
- This was my fault, I forgot to remove the link when I removed the file in #3914. I will remove it shortly.
Regarding my notes above, I made the assumption that every page in the wiki should be in the sidebar. I think that assumption is generally correct, but perhaps there are legitimate reasons some of these aren't listed there. If it is not clear for any of them, I will take a closer look and try to find out why.
wasn't able to find any links in /wiki/_Sidebar.md to any of the pages in /wiki/
Do you mean "any of the following pages"?
I made the assumption that every page in the wiki should be in the sidebar.
Anything that feels top-level should be. Things that are sub-pages of a linked page don't need to be in the sidebar.
I did a quick scan over the wiki pages, building up a spreadsheet that so far mainly keeps track of internal links. The document can be viewed at this link
The order of the pages was determined by starting in the homepage and essentially conducting breadth-first-search on the internal links to wiki pages. Once pages directly reachable from the homepage ran out, I went down the sidebar, then in alphabetical order on the ones not reachable from either. My intuition is that the more "handcrafted" a link is, the more important it is.
I made some more in-depth notes for the first few pages, but quickly decided to save that for another pass and only make note of external links that are broken.
Other than that, I have a few interesting observations:
- There are a total of 17 pages that can be accessed by starting in the homepage and clicking links within pages (not including the sidebar)
- There are 56 pages in the sidebar that cannot be reached directly from the homepage without the sidebar
- There are 4 orphan pages that can only be accessed from the dropdown above the sidebar:
Nice finds. We need to have a more integrated narrative, so that most pages ought to be reachable without the use of the sidebar. I'm not surprised though, as we did dump quite a lot of "related work" in the wiki that isn't part of the main narrative.