search

Center-for-Research-Libraries / crl-serials-validator

Validate bibliographic and holdings data for shared print.
GNU General Public License v3.0
0 stars 1 forks source link

Build out the project wiki, and move most of the docs to it #15

Closed nflorin closed 3 years ago

nflorin commented 3 years ago

I think theproject wiki is going to be a better place long term to keep docs than markdown files in the docs folder.

nflorin commented 3 years ago

I am going to delete the html files I've been creating with pandoc as part of this. Then I'm just going to copy over the markdown instructions to the wiki and build in some links on the home page.

After this the options are to mirror the wiki in the docs folder, or to delete the docs folder entirely, or to just keep some sort of minimal getting started docs in them. My preference would be to delete them and then build links to the wiki into the application itself -- the online wiki will be easier to keep updated, and also mirroring tends to lead to mistakes and versions that aren't exactly right for some reason.

nflorin commented 3 years ago

I did this, then decided instead to build out the docs and add links to them in the Validator itself. That seems cleaner. For now the project wiki will be left blank.