Finalize documentation

Author: iherman

generate/NewVersion.md

@@ -5,8 +5,8 @@ EPUB evolves. This repository was created while [EPUB 3.3](https://www.w3.org/T
 When upgrading from EPUB 3.n to EPUB 3.n+1, the following changes on the repository must be done:
 
 - Modify the `/Readme.md` file, changing the corresponding revision.
-- Modify the first paragraph of the introduction section of `/index.html` by updating the revision number and related URL-s.
+- Modify the first paragraph in the introduction section of `/index.html` by updating the revision number and related URL-s.
 - Modify the abstract section of `/results.html` by updating the revision number and related URL-s.
-- Modify the configuration file in `/generate/config.json` by expanding/updating the URL-s in the `"document_mappings"` array. The most important entries are the last two that are used to refer to the latest editors' drafts from the [test table](https://w3c.github.io/epub-tests/).
+- Modify the configuration file in `/generate/config.json` by expanding and/or updating the URL-s in the `"document_mappings"` array. The most important entries are the last two, used to refer to the latest editors' drafts from the [test table](https://w3c.github.io/epub-tests/).
 - Modify the metadata in the `/tests/xx-epub-template/EPUB/package.opf` and `/tests/xx-fixed-layout-template/EPUB/package.opf` files: the `<meta refines="#coverage" property="schema:version">` entry should refer to the latest revision number.
 - (Possibly update this document…)

generate/src/lib/data.ts

@@ -512,7 +512,8 @@ export async function getReportData(test_data: TestData[], reports: string): Pro
 }
 
 /**
- * Get a list of the tests file names, to be used to generate a template report.
+ * 
+ * Generate a template report that contains the list of all tests, with a placeholder for the results and the metadata
  * 
  * @param report the full report, as generated by earlier calls
  */

generate/src/main.ts

@@ -17,10 +17,14 @@
  * The implementation results are stored in the `/reports` directory. Each implementation 
  * report is stored in a separate JSON file, containing some metadata about the implementation, and the results of the tests. 
  * 
- * The `/generate/src/lib/types.ts` file contains, as part of the `Constants` namespace, the file names and directories for tests, final place for fragments, etc.
+ * Finally, the script also creates a template implementation result file (`/reports/xx-template.json`) that can be used to create new implementation reports.
+ * 
+ * ### Changing the configuration of the script
+ * 
+ * The `/generate/src/lib/types.ts` file contains, as part of the `Constants` namespace, the file and directories names for tests, final place for fragments, etc.
  * If the repository is reorganized or cloned, that file should be updated to reflect the new structure. 
  * 
- * Note that the current setup is based on release 3.4 of the EPUB 3 specification. See the separate `/generate/NewVersion.md` file for the steps to follow to
+ * The current setup is based on release 3.4 of the EPUB 3 specification. See the separate `/generate/NewVersion.md` file for the steps to follow to
  * update the repository for a new version of the EPUB 3 specification.
  * 
  * @license [W3C Software and Document License](https://www.w3.org/Consortium/Legal/copyright-software)