README.md in jekyll-theme-open-project-1.1.24 vs README.md in jekyll-theme-open-project-1.1.25

- old
+ new

@@ -273,10 +273,19 @@ # Tag can be prepended with a namespace to signify the type, # e.g. chosen programming language or target viewer audience # (see hub site configuration for tag namespace setup). # Avoid long namespace/tag combos as they can overflow item’s card widget. tags: [Ruby, Python, RFC, "<some_namespace_id>:<appropriate_tag>"] + +# NOTE: Must match corresponding hub site’s configuration entry. +tag_namespaces: + software: + namespace_id: "Human-readable namespace name" + # E.g.: + # writtenin: "Written in" + specs: + namespace_id: "Human-readable namespace name" ``` ### Project index page Create software index in _pages/projects.html, with nothing but frontmatter. @@ -457,13 +466,13 @@ source_url: https://example.com/spec-source-markup # Required. ``` -### Documentation for specs and software +### Documentation for software, and specification contents -Documentation contents for software should be kept in software +**Software docs** should be kept in software package’s own repository, under a directory such as `docs/`. Inside that directory, place a file called `navigation.md` containing only frontmatter, in format like this: ```yaml @@ -475,15 +484,40 @@ - name: Usage items: - basic ``` -In the same directory, place the required document pages—in this case, overview.md, -installation.md, and basic.md. Each document page is required to contain +In the same directory, place the required document pages—in this case, `overview.md`, +`installation.md`, and `basic.md`. Each document page is required to contain standard YAML frontmatter with at least `title` specified. -During project site build, Jekyll will pull docs for software products -that are hosted under that project site. +For **specification contents** to be built, provide configuration +and navigation in YAML frontmatter of corresponding `_specs/<specname>.adoc` file, +following this example: + +```yaml +spec_source: + git_repo_url: https://github.com/<user>/<repo> + git_repo_subtree: images + build: + engine: png_diagrams + +navigation: + sections: + - name: Model diagrams + items: + - title: "CSAND Normal Document" + path: "Csand_NormalDocument" + description: "" + ignore_missing: yes +``` + +For now, only the `png_diagrams` engine is supported, with Metanorma-based +project build engine to come. + +During project site build, Jekyll pulls software docs or spec contents +that are hosted under that project site. For spec contents, Jekyll runs +a build, if specified. ### Symbol Should look OK in dimensions of about 30x30, 60x60px. Must fit in a square. Should be in SVG format (see also the SVG guidelines section).