Update Documentation

[OmkarPh]

No description provided.

[AyanSinhaMahapatra]

Thanks++ @OmkarPh
See initial comments for your consideration.
The autobuild feature works great and is nice to have. Works on linux allright, so let's add it to the skeleton docs too, so it's there in other projects.
There are some warnings and errors shown on make dev:

ERROR: Unexpected indentation.
WARNING: Title underline too short
WARNING: duplicate label 
WARNING: Duplicate explicit target name

Would make sense to fix these too.

[OmkarPh]

ERROR: Unexpected indentation.
WARNING: Title underline too short
WARNING: duplicate label 
WARNING: Duplicate explicit target name

Oops, missed those

Edit: Fixed !

[AyanSinhaMahapatra]

@OmkarPh please add here the .readthedocs.yml file present at https://github.com/nexB/skeleton/blob/main/.readthedocs.yml also

[OmkarPh]

Hey @AyanSinhaMahapatra
I've incorporated the changes in docs, as discussed last week

Also, added some suggestions for the scancode-toolkit along with this PR - aboutcode-org/scancode-toolkit#3549

Can you push your doc improvements, or maybe merge into this branch itself

[AyanSinhaMahapatra]

@OmkarPh LGTM and thanks!
The docs at https://scancode-workbench.readthedocs.io/en/update-docs/ is now much more comprehensive and looks great.

All the points on more references between sections, using screenshots instead of gifs wherever possible and the misc updates in UI references are addressed and now looking great. 🙇

I'll add my few changes on top and we're ready to merge!

[AyanSinhaMahapatra]

@OmkarPh I just noticed we are actually not running the doc check scripts (build and style checks) present at https://github.com/nexB/scancode-workbench/tree/update/docs/docs/scripts in the CI. These have some minor errors to fix too, and added to a github actions.

See https://github.com/nexB/skeleton/blob/main/.github/workflows/docs-ci.yml
While you're at it, can you remove the chmod line at skeleton, I thing that's not required, if we chmod and commit the results.

[OmkarPh]

@OmkarPh I just noticed we are actually not running the doc check scripts (build and style checks) present at https://github.com/nexB/scancode-workbench/tree/update/docs/docs/scripts in the CI. These have some minor errors to fix too, and added to a github actions.

I've fixed the errors & the new docs CI is working fine now

See https://github.com/nexB/skeleton/blob/main/.github/workflows/docs-ci.yml While you're at it, can you remove the chmod line at skeleton, I thing that's not required, if we chmod and commit the results.

Yep, chmod is not required. I'll do this in skeleton PR also.

For future reference, tracking chmod using - git update-index --chmod=+x docs/scripts/doc8_style_check.sh

[OmkarPh]

Updated chmod & other docs in skeleton aboutcode-org/skeleton#83

[johnmhoran]

@OmkarPh @AyanSinhaMahapatra The updated ReadTheDocs looks great. It's well-organized, the expanations are clear and concise, and there are many good-looking (and helpful) illustrations.

I've also loaded a good-sized scan into SCWB 4.0.0rc4, and if possible I like this version even better than rc3. I did not realize how many different data views we had until I took the time to explore the data -- nicely done and very useful. The initial load process was fast and error-free. Navigation is fast fast fast.

I did notice that in the Table View, the values in the filter dropdowns for File extension, Copyright Holder and Copyright Author were not displayed in alphabetical order (I was unable to ID a pattern to the sort order). I think the sort order at some point in the past was alphabetical, which imho ought to be the default sort.

[DennisClark]

Everything looks good to me. The documentation is excellent and quite thorough.

[OmkarPh]

I did notice that in the Table View, the values in the filter dropdowns for File extension, Copyright Holder and Copyright Author were not displayed in alphabetical order (I was unable to ID a pattern to the sort order). I think the sort order at some point in the past was alphabetical, which imho ought to be the default sort.

yeah, having an alphabetical order would be nice, I'll update that in a different PR

[OmkarPh]

Thanks for the review @johnmhoran @DennisClark @AyanSinhaMahapatra 😄

[AyanSinhaMahapatra]

Thanks @OmkarPh for the updates, ready at last, merging!