search

Zettlr / zettlr-docs

This repository holds the official documentation of Zettlr
https://docs.zettlr.com/
GNU General Public License v3.0
158 stars 176 forks source link

old documentation links are still active. #151

Open adithyaappu opened 2 years ago

adithyaappu commented 2 years ago

I happen to search zettlr documentation through google, and landed on this page Virtual Directories

It took me a lot of time and reading through version histories and pull requests to figure out that it has been removed. Further going down, there are several confusing versions of the documentation that pops up in google search. All of them are pointing to different non-existent md file, in github like this, Core > File List

So there is some screw up happened in maintaining them. I'm not that good at coding so I could not figure out what went wrong.

nathanlesage commented 2 years ago

Thanks for noticing this — feel free to sift through all potentially dead/wrong links, then I can do a sweep over the docs and remove all of these things!

kerel-fs commented 1 year ago

I just wrote the script find_orphaned_files.py to find all those potentially orphaned pages. In a first step it checks the git history for deleted markdown files and in the second step it tries to download the corresponding page from the hosted docs. Finally it returns a list of all potentially orphaned pages.

List of orphaned pages:
  • https://docs.zettlr.com/de/core/virtual-directories
  • https://docs.zettlr.com/en/5-minutes
  • https://docs.zettlr.com/en/core/attachments
  • https://docs.zettlr.com/en/core/virtual-directories
  • https://docs.zettlr.com/en/guides/guide-ide
  • https://docs.zettlr.com/en/guides/guide-notes
  • https://docs.zettlr.com/en/guides/guide-zettelkasten
  • https://docs.zettlr.com/en/installing-pandoc
  • https://docs.zettlr.com/fr/5-minutes
  • https://docs.zettlr.com/fr/core/virtual-directories
  • https://docs.zettlr.com/it/core/virtual-directories
  • https://docs.zettlr.com/ja/5-minutes
  • https://docs.zettlr.com/ja/concepts/roots
  • https://docs.zettlr.com/ja/core/attachments
  • https://docs.zettlr.com/ja/core/file-list
  • https://docs.zettlr.com/ja/core/virtual-directories
  • https://docs.zettlr.com/ja/guides/guide-ide
  • https://docs.zettlr.com/ja/guides/guide-notes
  • https://docs.zettlr.com/ja/guides/guide-zettelkasten
  • https://docs.zettlr.com/ja/installing-pandoc

    • plaintext output: 2022-12-20_orphaned_pages.md

    If you are interested in the script itself I will open a PR for it here.

    edit: Manually checked all pages, they are true orphans.