Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
brtnfld committed Jan 9, 2025
2 parents 24afe51 + c0613c8 commit 130d966
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 16 deletions.
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 130d966

Please sign in to comment.