Added version section to README.md for all specifications

browser-landing/README.md

@@ -4,6 +4,11 @@
 
 The main objective for this spec is to generate a page of links to genome browsers for a genus, following a specified ordering of the species and the accessions and annotations within each species. The requirement of specifying the ordering forces reliance on one or more hand-generated files that establish that ordering. Those files exist in the Datastore metadata, in two types of "description_....yml" files.
 
+## Specification version
+Version: 1.0.0
+
+Notes: This specification was completed mid-July, 2023. Implementation of the page was completed by late July, and may differ in some details from this spec - e.g. in layout of the assembly descriptions, citation, and browser link.
+
 ## Implementation: 
 
 Determine the species ordering using the `GENUS/description_[glycine].yml` files:

gene-function-search/README.md

@@ -2,6 +2,11 @@
 
 This is the requirements doc for the LIS, SoyBase, and PeanutBase gene function search, to be implemented on the respective Jekyll web sites. This should serve gene function information that is being curated at, for example, [https://data.legumeinfo.org/Glycine/max/gene_functions/](https://data.legumeinfo.org/Glycine/max/gene_functions/). Note though: the data will need to be incorporated into the Mines before this search functionality can be implemented.
 
+## Specification version
+Version: 0.9.0
+
+Notes: This specification was completed in late June, 2023. The specification preceded availability of the data in the mines, so additional review and revision of the spec may be needed before the first implementation.
+
 ## Input
 
 - Genus (selector with "any" on top)

gene-search/README.md

@@ -2,6 +2,15 @@
 
 This is the requirements doc for the LIS gene search to be implemented on the LIS Jekyll web site.
 
+## Specification version
+Version: 1.1.0
+
+Notes: A draft implementation of this specification was completed in late March 2023. Based on review of that implementation, additional changes were made to better handle pagination and back-navigation from the modal linkouts results window.
+
+After another round of review in mid-July 2023, the intermediate output was changed from vertical layout of the results for each gene to a tabular layout per gene.
+
+The history above predates a versioning system for these website-ui specs. In October 2023, semantic versioning was added, with 1.1.0 being used in this spec to reflect the first production release of this gene-search web component -- subversion .1 indicating that significant changes were made in June-July after review of the initial implementation in March.
+
 ## Input
 
 - genus (selector with "any" on top)

pangenes-search/README.md

@@ -2,6 +2,11 @@
 
 This is the requirements doc for the LIS, SoyBase, and PeanutBase pangenes search, to be implemented on the respective Jekyll web sites. This search component should enable search of corresponding genes (genes from different accessions), via pangene membership. The primary link targets are those relevant for genes (probably the same as for the gene search).
 
+## Specification version
+Version: 0.9.0
+
+Notes: This specification was completed in late July, 2023. The specification preceded availability of the data in the mines, so additional review and revision of the spec may be needed before the first implementation.
+
 ## Input
 
 - Genus (selector with "any" on top. For SoyBase, only Glycine; for PeanutBase, only Arachis)

trait-search/README.md

@@ -2,6 +2,11 @@
 
 This is the requirements doc for the LIS, SoyBase, and PeanutBase trait association search, to be implemented on the respective Jekyll web sites. This search component should enable search of both QTL and GWAS studies. The primary (though not exclusive) link targets are the QTL and GWAS reports at the LIS InterMine instances -- for example, [GWAS "days to flower"](https://mines.legumeinfo.org/glycinemine/report.do?id=145000005) or [QTL "first flower"](https://mines.legumeinfo.org/glycinemine/report.do?id=235000009).
 
+## Specification version
+Version: 1.0.0
+
+Notes: This specification was completed in mid-July, 2023, and is ready for initial implementation.
+
 ## Input
 
 - Genus (selector with "any" on top)