The README.md file is starting to get a bit big. In this issue, we'll create a directory called attachment-converter/doc whose purpose is to house all sections of README.md that we choose to break out into separate files.
First on deck to go into the doc/ directory will be a document explaining the workflow for developing under a sandboxed Opam switch, which we'll call sandboxing.md. Sort of as a 'test run' for putting docs there. We'll also move file-format-conversions.md in there.
bufordrat
commented
2 years ago
Move documentation into its own part of the app
The
README.mdfile is starting to get a bit big. In this issue, we'll create a directory calledattachment-converter/docwhose purpose is to house all sections ofREADME.mdthat we choose to break out into separate files.First on deck to go into the
doc/directory will be a document explaining the workflow for developing under a sandboxed Opam switch, which we'll callsandboxing.md. Sort of as a 'test run' for putting docs there. We'll also movefile-format-conversions.mdin there.