From 795e299ecfcc1ba317e446ab89d31736b9118dcd Mon Sep 17 00:00:00 2001 From: Jae Hoon Seo Date: Fri, 16 Oct 2026 17:29:03 +0900 Subject: [PATCH 1/2] Name the linked project files in the README by their purpose. --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ac51b98..059684f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ The public API is documented in the [API reference](https://vane.readthedocs.io/en/latest/reference/api_reference.html) and is stable. VANE follows semantic versioning: a breaking change to the documented public API is made only with a new major version and is recorded in the -[CHANGELOG](CHANGELOG.md). +[changelog](CHANGELOG.md). ## Capabilities @@ -111,7 +111,7 @@ vane study path/to/lin_files --parameter wind -o study_output The manual at covers installation, the quick start, the OpenFAST linearization sweep, mode identification, Campbell diagrams, state-space export, azimuth averaging, step-by-step tutorials, the theory, the validation record, -and the API reference. The tutorial scripts are in [`examples/`](examples/README.md); +and the API reference. The tutorial scripts are in the [examples folder](examples/README.md); all but the OpenFAST sweep run on synthetic inputs without OpenFAST. ## Validation @@ -120,7 +120,8 @@ VANE is verified against analytical solutions, exact invariants and prescribed-m models, and has been run end to end on the OpenFAST `r-test` reference systems (NREL 5 MW on land, OC3 monopile, OC3 Hywind spar, OC4 DeepCwind semi-submersible) and on the NREL 5 MW and IEA 3.4, 10, 15 and 22 MW reference turbines. Cases, acceptance -values and the tests that reproduce them are in [VALIDATION.md](VALIDATION.md). +values and the tests that reproduce them are in the +[validation record](VALIDATION.md). ## Repository layout @@ -132,23 +133,23 @@ values and the tests that reproduce them are in [VALIDATION.md](VALIDATION.md). | `examples/` | Runnable tutorial scripts | | `.github/` | Continuous integration, issue and pull-request templates | -The package structure is described in [ARCHITECTURE.md](ARCHITECTURE.md). +The package structure is described in the [architecture overview](ARCHITECTURE.md). ## Citing If you use VANE in academic work, please cite the software release you used -(VANE 0.1.0). [CITATION.cff](CITATION.cff) holds the citation metadata (GitHub **Cite -this repository**); BibTeX is on the manual's +(VANE 0.1.0). The [citation file](CITATION.cff) holds the citation metadata (GitHub +**Cite this repository**); BibTeX is on the manual's [How to cite](https://vane.readthedocs.io/en/latest/user_guide/citing.html) page. ## Contributing and support Questions, bug reports and feature requests are welcome in [GitHub Issues](https://github.com/SMI-Lab-Inha/VANE/issues); see -[SUPPORT.md](SUPPORT.md) for where each belongs. Read -[CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Everyone taking part +the [support guide](SUPPORT.md) for where each belongs. Read the +[contributing guide](CONTRIBUTING.md) before opening a pull request. Everyone taking part is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). Report security -issues privately as described in [SECURITY.md](SECURITY.md). +issues privately as described in the [security policy](SECURITY.md). VANE is research software. Users are responsible for model selection, convergence checks and the engineering decisions they base on its results. From 1534bc56d23eebfc1ef950ed3f5c3c52e9f21801 Mon Sep 17 00:00:00 2001 From: Jae Hoon Seo Date: Fri, 16 Oct 2026 17:48:25 +0900 Subject: [PATCH 2/2] Serve the documentation badge from shields.io. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 059684f..5bef0c3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Release](https://img.shields.io/github/v/release/SMI-Lab-Inha/VANE?sort=semver)](https://github.com/SMI-Lab-Inha/VANE/releases/latest) [![CI](https://github.com/SMI-Lab-Inha/VANE/actions/workflows/python.yml/badge.svg)](https://github.com/SMI-Lab-Inha/VANE/actions/workflows/python.yml) -[![Documentation](https://readthedocs.org/projects/vane/badge/?version=latest)](https://vane.readthedocs.io/en/latest/) +[![Documentation](https://img.shields.io/readthedocs/vane/latest?label=docs)](https://vane.readthedocs.io/en/latest/) [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) [![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](pyproject.toml)