user-docs VS docsify

Integrate SCA Early and Continuously: Integrate software composition analysis (SCA) into your CI/CD pipeline for automated scans on every pull request. This detects and blocks vulnerable dependencies before they reach production. Examples of solutions: Amazon Inspector, Snyk Open Source, Jit Software Composition Analysis (SCA).

- CWE-1395: Dependency on Vulnerable Third-Party Component

From Snyk's docs they also explain it: https://github.com/snyk/user-docs/blob/main/docs/manage-risk...

"In almost all cases, malicious packages are not assigned a CVE ID."

I had wanted to use Gitbook for blog/wiki[0] but then discovered that it's not opensource anymore. After not finding anything for a long while finally found something close that will work for me: Docsify[1].

Docsify is git-backed but not a static site generator. Instead it reads the markdown as-is and renders to HTML/DOM (don't know the details) in the browser. I had 2 problems with it, first the sidebar wasn't convenient to edit/update, which I handled by creating a tags: `name` `name` annotation convention. The second was it didn't work for private github repos, which was solved by using Cloudflare Pages to auto-publish changes from git. Effectively now it has a 'build' step like a static-site-generator but it's only to write _sidebar.md from the tagged .md files.

You can see the start of my personal wiki/notes[2] which includes some info about Docsify and Cloudflare Pages & Access (transparently login protect http routes). Note the 'Edit' buttons won't work (as you don't have access to private repo).*

[0] https://blog.keithkim.org

[1] https://docsify.js.org

[2] https://notes.keithkim.org

I built a fast, responsive, and lightweight static documentation site powered by Docsify, hosted on AWS S3 with a CloudFront CDN for global distribution. The entire infrastructure is managed using Pulumi YAML, allowing me to declaratively define and deploy resources without writing any imperative code.

📂 GitHub Repository 🌐 Website

Docsify is frequently updated; the latest release was on June 24, 2023, and the most recent update was on December 17, 2023. It is MIT-licensed and has an active Discord community.

okay new plan, does anyone know how to do this docsify on github? i obviously am a noob on github and recently on reddit. I'd like to help where i can but my knowlegde seems to be my handycap. i could provide you a trash-mail, if you need one, but i need a PO (product owner) to manage the git... i have no clue about this yet (pages and functions and stuff)

The tools to author it aren't that important, frankly. Ask your audience what they're most comfortable using and try to meet them there.

If the stakeholders are technical, you have more options. If they aren't, I hope you like Google Docs or Word, because if you give them anything other than that or a PDF, they'll probably complain. At worst, yeah, write it in a long Markdown text file and use tools like pandoc to transform that into other formats as needed.

If you do need a website and you're not generating enterprise-scale amounts of content (and it sounds like you're not) try things that let you avoid needing build steps and infrastructure if at all possible, so you can iterate and deploy changes with as little friction as you can.

Tools like Docsify[1] can take a pile of Markdown files and serve a site out of them, client- or server-side, without a static build step. Depending on the org, you can get away with GitHub's default rendering of Markdown in a repo. Most static site builds for stuff your scale are overengineered instances of premature optimization.

Past those initial hurdles, the format and tools challenges are all in maintenance. How can you:

- most easily keep the content up to date

- delegate updates as the staff grows or changes

- proactively distribute updates ASAP to the people who'd most benefit from receiving them

That's going to depend a lot more on who'll contribute updates, what their technical proficiency's like, and how they prefer to communicate. It might be a shared git repo and RSS or Slack notifications if they're comfortable with those things, and it might be a Google Doc and email if they're like most non-technical stakeholders.

1: https://docsify.js.org

Big fan of https://docsify.js.org since theres no need to compile your static site. A small amount of js just renders markdown.

If you are searching for examples of an arbitrary Jellyfin support site, visit https://travisflix.com/help/#/support (or help.travisflix.com which redirects to the /help/ URI of the TLD) to take a look at what I have done with docsify on Github Pages.