hm.. nice! I made one theme for myself (github[1], vscode[2]) and wanted to try to upload my json to see how it looks like in your interface... (for a screenshot proposes).
Author here. I tried to work with kubeflow[1] project this summer, and i got a lot of 404 reading it's documentation, which outranged me a bit. I wrote two functions php script and checked kubeflow site for deadlinks, made a few PR and hopefully fix the situation a bit. During hacktoberfest I made a tool called a deadlinks[2] (I am kinda bad in naming things), and start checking different project documentation for this kind of error (hey guys if you remember me - cheers!). I have discovered that there are (almost) no documentation without such errors. Every single one has it (except hashicorp tools, they are good!).
I start spending more time trying to improve deadlinks, and define use cases. Currently, I am working more on the kubenetes website and deadlinks swinging back and forth, and I think we are ready to be used.
I made simple documentation[3] so you can check examples and how this tool can be integrated into existing ci/cd systems.
How can it be useful for your opensource project/static website?
1. You can check it on broken links during CI.
2. You can apply it to a folder with files or to a server (standalone or ssg powered).
3. If you switching SSG you can check what will be the difference in terms of a number of broken links.
4. It's available as pip package, brew and docker image.
This comment has nothing to do with apple, but about documentation in general.
I was trying to get into Kubernetes world via kubeflow, a machine learning platform that works on top of the Kubernetes. Well, I have run into a bunch of the missing examples, outdated articles, and things that just don't work (all of that in official documentation).
I decide to change this a bit and start working on a small tool [1] that can help check documentation (at least reduce deadlinks in the documentation, when someone moves git files or just original source of info dies). Since I start working on it, I meet only one project without issues, all others.. well, they all had issues.
Maybe one day I post it on HN as a standalone link, but now here we go [1]
- During peak production periods, resignations are not approved.
- Some dispatch workers have not received promised bonuses.
- Student workers do overtime during peak production season, even though regulations on student internships prohibit this.
- Some workers put in at least 100 overtime hours each month, during busy production periods. Chinese labor law limits monthly overtime to 36 hours.
- Workers must get approval to not do overtime. If requests are denied and staff still choose not to work overtime, they are admonished by managers and miss out on future overtime opportunities.
- Workers sometimes have to stay at the factory for unpaid meetings at night.
- The factory doesn’t provide adequate protective equipment for staff.
- Work injuries are not reported by the factory, and verbal abuse is common there.