diff --git a/README.md b/README.md index 75227d8..e8abba4 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ -# CGNS DOCUMENTATION - -https://github.com/CGNS/cgns.github.io is the location for CGNS current documentation -published at https://cgns.github.io - -https://github.com/CGNS/cgns-archives is the location for CGNS previous documentation -published at https://cgns.github.io/cgns-archives - -## Documentation Development - -The CGNS documentation uses the branching/release model as summarized at: - -http://nvie.com/posts/a-successful-git-branching-model/ - -![image](https://github.com/CGNS/cgns.github.io/blob/master/.github/images/git-model.png) +# CGNS DOCUMENTATION + +https://github.com/CGNS/cgns.github.io is the location for CGNS current documentation +published at https://cgns.github.io + +https://github.com/CGNS/cgns-archives is the location for CGNS previous documentation +published at https://cgns.github.io/cgns-archives + +## Documentation Development + +> [!IMPORTANT] +> Minor changes to the documentation, such as grammar corrections and general +> clarifications, can be pushed to the 'master' branch at any time. However, +> documentation related to specific CGNS release topics should only be made +> in the 'develop' branch. Once a CGNS release occurs, those changes can be merged +> into the 'master' branch and tagged in sync with the CGNS library release. + +> [!NOTE] +> cgns.org is rendered from the 'master' branch contents. + +The CGNS documentation uses the branching/release model as summarized at: + +http://nvie.com/posts/a-successful-git-branching-model/ + +![image](https://github.com/CGNS/cgns.github.io/blob/master/.github/images/git-model.png) diff --git a/conf.py b/conf.py index cdf0bc7..9015edf 100644 --- a/conf.py +++ b/conf.py @@ -101,7 +101,7 @@ # These paths are either relative to html_static_path # or fully qualified paths (eg. https://...) -html_css_files = ["css/custom.css"] +html_css_files = ["css/custom.css", 'css/filemap.css'] html_theme_options = { "repository_url": "https://github.com/CGNS/cgns-modern.github.io", "use_issues_button": True,