From ef33495485172c2de303529999a20691b5123bfc Mon Sep 17 00:00:00 2001 From: Chris Black Date: Fri, 5 Dec 2025 11:11:06 -0800 Subject: [PATCH 1/2] add recent and upcoming doc releases; update main branch links to "latest" --- README.md | 4 +- docusaurus.config.js | 2 +- src/pages/documentation.js | 54 +++++++++++++++++-- .../documentation/{master.js => latest.js} | 8 +-- src/pages/documentation/v1_10_0.js | 30 +++++++++++ src/pages/documentation/v1_8_0.js | 30 +++++++++++ src/pages/documentation/v1_9_0.js | 30 +++++++++++ src/pages/index.js | 2 +- src/pages/news.js | 2 +- src/pages/tutorials.js | 18 +++---- 10 files changed, 159 insertions(+), 21 deletions(-) rename src/pages/documentation/{master.js => latest.js} (88%) create mode 100644 src/pages/documentation/v1_10_0.js create mode 100644 src/pages/documentation/v1_8_0.js create mode 100644 src/pages/documentation/v1_9_0.js diff --git a/README.md b/README.md index 4b114245..dd53d80c 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ This describes how to add or modify the Website's content. This is an open source project and contributions are what make an open source community. Everyone is welcome to contribute to this project. -All involved are expected to follow the [PEcAn code of conduct](https://pecanproject.github.io/pecan-documentation/master/contributor-covenant-code-of-conduct.html) and contribute to a positive and inclusive environment. +All involved are expected to follow the [PEcAn code of conduct](https://pecanproject.github.io/pecan-documentation/develop/contributor-covenant-code-of-conduct.html) and contribute to a positive and inclusive environment. First time contributors are welcome. Contributions can be very simple, make sure to check out issues labeled ['good first issue'](https://github.com/PecanProject/PecanProject.github.io/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22). If you have an idea, the best place to start a discussion is on the PEcAn project Slack channel, or by opening an issue in this repository. @@ -209,7 +209,7 @@ This section contains future plans for the website. New contributors can use thi ### Optimising Documentation -At present the PEcAn's documentation is being served from () using an iframe. While this saves a lot of overhead in converting Rmd files in () to md files so that docusaurus could render them, it also increases the loading time for documentation, it also looks less consistent. +At present the PEcAn's documentation is being served from () using an iframe. While this saves a lot of overhead in converting Rmd files in () to md files so that docusaurus could render them, it also increases the loading time for documentation, it also looks less consistent. In future, it is suggested to find an optimised way to convert rmd files to md and integrate them via docusaurus's native documentation parser. ### Adding tutorials section diff --git a/docusaurus.config.js b/docusaurus.config.js index f7c37239..4403b2f3 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -71,7 +71,7 @@ module.exports = { items: [ { label: "Tutorial", - to: "/documentation/master", + to: "/documentation/latest", className: "footer-docs-link", }, ], diff --git a/src/pages/documentation.js b/src/pages/documentation.js index 8beac131..d1608431 100644 --- a/src/pages/documentation.js +++ b/src/pages/documentation.js @@ -6,6 +6,23 @@ function Documentation() { return (
+
+ {" "} +
+
+
+ +

Latest Code Documentation

+ +
+
+

+ Documentation consistent with latest stable code (DEVELOP BRANCH). +

+
+
+
+
@@ -28,12 +45,43 @@ function Documentation() {
-

Latest Code Documentation

+

Release 1.10.0

+
+
+

+ Documentation consistent with release 1.10.0. +

+
+
+
+ + +
+ {" "} +
+
+
+ +

Release 1.8.0

+
+
+

+ Documentation consistent with release 1.8.0.

diff --git a/src/pages/documentation/master.js b/src/pages/documentation/latest.js similarity index 88% rename from src/pages/documentation/master.js rename to src/pages/documentation/latest.js index ead944b3..a2fed69f 100644 --- a/src/pages/documentation/master.js +++ b/src/pages/documentation/latest.js @@ -2,15 +2,15 @@ import React from "react"; import Layout from "@theme/Layout"; import "./documentation.css"; import Foot from "@docusaurus/Head"; -function Master() { +function Latest() { return ( <> - + + + + ); +} + +export default V_1_10_0; diff --git a/src/pages/documentation/v1_8_0.js b/src/pages/documentation/v1_8_0.js new file mode 100644 index 00000000..ad70017b --- /dev/null +++ b/src/pages/documentation/v1_8_0.js @@ -0,0 +1,30 @@ +import React from "react"; +import Layout from "@theme/Layout"; +import "./documentation.css"; +import Foot from "@docusaurus/Head"; +function V1_8_0() { + return ( + <> + + + + + + + + ); +} + +export default V_1_8_0; diff --git a/src/pages/documentation/v1_9_0.js b/src/pages/documentation/v1_9_0.js new file mode 100644 index 00000000..46dabbf1 --- /dev/null +++ b/src/pages/documentation/v1_9_0.js @@ -0,0 +1,30 @@ +import React from "react"; +import Layout from "@theme/Layout"; +import "./documentation.css"; +import Foot from "@docusaurus/Head"; +function V1_9_0() { + return ( + <> + + + + + + + + ); +} + +export default V_1_9_0; diff --git a/src/pages/index.js b/src/pages/index.js index 63eee690..bfebbd62 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -15,7 +15,7 @@ function HomepageHeader() {
Get started diff --git a/src/pages/news.js b/src/pages/news.js index 15911647..c82f8837 100644 --- a/src/pages/news.js +++ b/src/pages/news.js @@ -1475,7 +1475,7 @@ function News() { A few functions have already been added to the rOpensci traits package that can be found in the file R/betydb.R. + href="https://github.com/ropensci/traits/blob/main/R/betydb.R">R/betydb.R.

If you can help resolve open issues, implement new functionality, and write vignettes please contact betydb@gmail.com, submit a pull request diff --git a/src/pages/tutorials.js b/src/pages/tutorials.js index 14febedc..29b062a8 100644 --- a/src/pages/tutorials.js +++ b/src/pages/tutorials.js @@ -97,25 +97,25 @@ function Tutorials() {

R Packages

- + -
MCMC - in development
+
MCMC - in development
- + - + - + - + - +

Concepts

- + - +

Video:

From 545aecd28dade5b64ccd97ddcafce9d468ddfd90 Mon Sep 17 00:00:00 2001 From: Gandalf Date: Sat, 6 Dec 2025 01:26:18 +0530 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- src/pages/documentation/v1_10_0.js | 2 +- src/pages/documentation/v1_8_0.js | 2 +- src/pages/documentation/v1_9_0.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/pages/documentation/v1_10_0.js b/src/pages/documentation/v1_10_0.js index 26785a15..5ed611aa 100644 --- a/src/pages/documentation/v1_10_0.js +++ b/src/pages/documentation/v1_10_0.js @@ -27,4 +27,4 @@ function V1_10_0() { ); } -export default V_1_10_0; +export default V1_10_0; diff --git a/src/pages/documentation/v1_8_0.js b/src/pages/documentation/v1_8_0.js index ad70017b..b5f4cc02 100644 --- a/src/pages/documentation/v1_8_0.js +++ b/src/pages/documentation/v1_8_0.js @@ -27,4 +27,4 @@ function V1_8_0() { ); } -export default V_1_8_0; +export default V1_8_0; diff --git a/src/pages/documentation/v1_9_0.js b/src/pages/documentation/v1_9_0.js index 46dabbf1..82ee831e 100644 --- a/src/pages/documentation/v1_9_0.js +++ b/src/pages/documentation/v1_9_0.js @@ -27,4 +27,4 @@ function V1_9_0() { ); } -export default V_1_9_0; +export default V1_9_0;