bangsluke Documentation

bangsluke Documentation

Jun 2023 - Jul 2024

Category: Documentation
Docusaurus icon Docusaurus
Used in 2 projects
Markdown icon Markdown
Used in 4 projects
GitHub icon GitHub
Used in 16 projects
Netlify icon Netlify
Used in 13 projects
Snyk icon Snyk
Used in 14 projects
Algolia icon Algolia
Used in 1 project
Yarn icon Yarn
Used in 6 projects
VS Code icon VS Code
Used in 22 projects
React icon React
Used in 15 projects

Description

Broken out into several sections, my documentation site provides me top level links to key softwares and guides me through each project, from planning, installation and set up to develop, testing and deployment. It also holds details on the Dorkinians FC stats and how to maintain them - for handover to others.

I regularly keep it updated with new links and processes I find so that it remains relevant to the work I am doing.

Outside of the documentation section, the repo also contains my Homepage and New Tab pages as the whole repo is hosted through GitHub pages.

Lessons Learned

This project introduced me to the concept of documentation sites, the ease and brilliance of Markdown and led me to notice how many different techs either use Docusaurus or a very similar type static site builder for their documentation.

I also learned how to set up offline caching to enable me to access the PWA without connection on my mobile device.