search

JuliaPackaging / Scratch.jl

Scratch spaces for all your persistent mutable data needs
MIT License
58 stars 11 forks source link

Add minimal documentation stub #40

Closed fingolfin closed 1 year ago

fingolfin commented 1 year ago

This makes progress towards resolving #37. Of course it's not there yet, because the generated docs are missing most of the useful information in the README.md... But at least it is a start.

To make further progress, we could just copy that from the README.md to the manual, but now the same text lives in two places and needs to be kept in sync. Perhaps it would be better to move most of the text in the README.md and just retain a link to the manual plus perhaps some quick examples?

Thoughts?

codecov[bot] commented 1 year ago

Codecov Report

Merging #40 (8efeb24) into master (5cb2536) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #40   +/-   ##
=======================================
  Coverage   87.61%   87.61%           
=======================================
  Files           1        1           
  Lines         105      105           
=======================================
  Hits           92       92           
  Misses         13       13

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

staticfloat commented 1 year ago

I like the idea of transitioning to a more complete docs page.