documentation issues

[Andrew Ziem]

from tiemay

Using truncate is better for POSIX systems, but will it work on non-POSIX systems? Which systems would that be?

Documentation for cleaning .ini files and JSON files?

Documentation for using the <running> check? When should it be used? What options does it have? Which operating systems should it work on? .etc

http://bleachbit.sourceforge.net/documentation/preferences "Hide irrelevant cleaners" section seems to be obsolete

http://bleachbit.sourceforge.net/help links to http://bleachbit.blogspot.com/2009/07/bleachbit-053-released.html#video but should link to http://bleachbit.sourceforge.net/videos like on http://bleachbit.sourceforge.net/documentation/general-usage

http://bleachbit.sourceforge.net/documentation/command-line under "Deleting files" says to use --delete, which seems to have been replaced by --clean

http://bleachbit.sourceforge.net/documentation/command-line Doesn't cover --shred --sysinfo --gui --version or --help

http://bleachbit.sourceforge.net/documentation/faq "BleachBit identifies and organizes the files you are most likely want to delete." is a fragmented sentence.

http://bleachbit.sourceforge.net/documentation/faq "(other than the rare SSDs)" SSDs aren't really rare anymore; they're not entirely mainstream either, but it probably will become so in the near future. I'm probably going to get this one soon to use alongside my HDD https://teksyndicate.com/videos/plextor-m6s-ssd-review-and-benchmark-wendell-video

http://bleachbit.sourceforge.net/documentation/shred-files-wipe-disk could provide info about secure erasing flash storage devices like SSDs, USB flash drives, SD cards .etc.

http://bleachbit.sourceforge.net/documentation/shred-files-wipe-disk "Do the authors not honestly know what they are doing, or is a useless feature for marketing purposes?" is a fragmented sentence.

http://bleachbit.sourceforge.net/documentation/cleanerml under "Finding files to delete" I'm not sure how to get number 5 working. On linux, what command might I use? I tried doing `./Makefile`, but only got what look to be errors.

http://bleachbit.sourceforge.net/contribute/cleaner under "Testing the cleaner" says to never use ~ in windows. Is this still true? The gimp cleaner uses it and it worked for me on Windows 7.

http://bleachbit.sourceforge.net/documentation/winapp2_ini first says bleachbit 0.8.7 is needed, then says 0.8.8

http://bleachbit.sourceforge.net/documentation/winapp2_ini "See CleanerML storage for more options." should probably link to http://bleachbit.sourceforge.net/documentation/cleanerml#storage

http://bleachbit.sourceforge.net/documentation/running-source-code links to bleachbit-misc? which just goes to github/az0/bleachbit, just like the link above it. Was it suposed to go to https://github.com/az0/bleachbit-misc ?

http://bleachbit.sourceforge.net/documentation/running-source-code "change es according to the language" could maybe link to a list of available language codes with the full name of the language in that language and maybe english to.

http://bleachbit.sourceforge.net/contribute/testing "Testing environment" section links to http://bleachbit.sourceforge.net/category/blog-tags/beta However that list doesn't have the two most recent betas: 1.3 and 1.1. Are they not tagged like the other blog entries?

http://bleachbit.sourceforge.net/contribute/testing says "Don't forget to install the bonus pack." was that replaced by the github cleanerml repo?

http://bleachbit.sourceforge.net/contribute/testing under the "Abort" section, it refers to using "top", this is a very vague name, and I couldn't find this program. A link to it's homepage might be helpful.

http://bleachbit.sourceforge.net/contribute/testing the "Betas" section doesn't link to the newer beta releases. Perhaps it should simply link to http://bleachbit.sourceforge.net/category/blog-tags/beta so it will always be up to date, and without additional maintenance

http://bleachbit.sourceforge.net/contribute/testing "Filing new bugs" section links to http://bleachbit.sourceforge.net/contribute when it looks like it meant to link to https://bugs.launchpad.net/bleachbit and/or maybe the issues pages on github.

[Andrew Ziem (ahziem1)]

Though not on your list, I updated http://bleachbit.sourceforge.net/documentation/installation

I still need to update the others

[Andrew Ziem (ahziem1)]

This is a work in progress to make the documentation maintainable by the community on GitHub

https://github.com/bleachbit/test/tree/gh-pages/_posts
https://bleachbit.github.io/test/dev/running-from-source-code.html

It is not quite ready for contributions yet

[Andrew Ziem (ahziem1)]

Would you please be able to make pull requests for these changes? Breaking them up into not-too-big chunks makes them easier to review and approve.

If not, let me know.

Git repository
https://github.com/bleachbit/docs

Readable documentation
https://bleachbit.github.io/docs/

[Andrew Ziem (ahziem1)]

There are already many fixes ready for BleachBit version 1.12, so I would like to not delay releasing what is ready. I am rescheduling for another release.

Also anyone is free to submit pull requests against the new documentation GitHub repository.

[Andrew Ziem (ahziem1)]

BleachBit now uses GitHub to manage documentation, so please file issues (individually) or pull requests there.