From 240272fb138fc2e3538fd852a9ceab41a663d81b Mon Sep 17 00:00:00 2001 From: Kevin Bonham Date: Sun, 30 Jul 2023 10:59:03 -0400 Subject: [PATCH 1/2] update links --- README.md | 11 ++++++----- docs/make.jl | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c294bd2..7145f16 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,18 @@ > Note: This landing site is under extensive development and will receive frequent updates. > It is not in a ready state, and is published under GitHub Pages only for testing purposes. -[![GitHub Pages status](https://github.com/M-PERSIC/BioJuliaDocs/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/M-PERSIC/BioJuliaDocs/actions/workflows/pages/pages-build-deployment) -[![Static Badge](https://img.shields.io/badge/Docs-stable-blue)](https://m-persic.github.io/BioJuliaDocs) +[![GitHub Pages status](https://github.com/BioJulia/BioJuliaDocs/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/BioJulia/BioJuliaDocs/actions/workflows/pages/pages-build-deployment) +[![Static Badge](https://img.shields.io/badge/Docs-stable-blue)](https://biojulia.dev/BioJuliaDocs) -### Enter m-persic.github.io/BioJuliaDocs into your search bar for the live GitHub Pages site! +### Enter biojulia.dev/BioJuliaDocs into your search bar for the live GitHub Pages site! ## Description The BioJuliaDocs initiative is an in-development project to produce a landing site for BioJulia similar to [SciMLDocs](https://github.com/SciML/SciMLDocs) (see the production page [here](https://docs.sciml.ai/Overview/stable/)). ## Testing -The rendered BioJuliaDocs site, for testing purposes, is published online using GitHub Pages at [m-persic.github.io/BioJuliaDocs](https://m-persic.github.io/BioJuliaDocs). A GitHub action rebuilds the site on every successful pull request. +The rendered BioJuliaDocs site, for testing purposes, is published online using GitHub Pages at [biojulia.dev/BioJuliaDocs](https://biojulia.dev/BioJuliaDocs). A GitHub action rebuilds the site on every successful pull request. ## Contributing We appreciate contributions from users/members of the BioJulia commmunity including reporting bugs/typos, fixing issues, and adding new sections. This is a fantastic opportunity to polish one's technical writing skills as well as show off one's skill with BioJulia packages ;) @@ -23,6 +23,7 @@ Take a look at the [contributing files](https://github.com/BioJulia/Contributing detailed contributor and maintainer guidelines, and code of conduct. ## Questions? -Feel free to open a new discussion under the [BioJuliaDocs Discussions](https://github.com/M-PERSIC/BioJuliaDocs/discussions) section. Alternatively, one can chat with the community either via the [Slack](https://julialang.org/slack/) #biology workspace or in the [forums](https://discourse.julialang.org/). + +Feel free to open a new discussion under the [BioJuliaDocs Discussions](https://github.com/BioJulia/discussions) section. Alternatively, one can chat with the community either via the [Slack](https://julialang.org/slack/) #biology workspace or in the [forums](https://discourse.julialang.org/). This project is lead by [Michael Persico](mailto:michael.a.persico@gmail.com?subject=[GitHub]) (him/il) as part of a Julia Summer of Code project. Feel free to contact me directly should you wish to address any concerns privately. diff --git a/docs/make.jl b/docs/make.jl index 6f709f6..70e44f5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -28,5 +28,5 @@ makedocs( ) deploydocs( - repo = "https://github.com/M-PERSIC/BioJuliaDocs.git" + repo = "https://github.com/BioJulia/BioJuliaDocs.git" ) From 91b0816092dd11dfb32e11033e14ce504dbde785 Mon Sep 17 00:00:00 2001 From: Kevin Bonham Date: Sun, 30 Jul 2023 11:01:20 -0400 Subject: [PATCH 2/2] markdown styles (esp sembr) --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7145f16..a203775 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,35 @@ # BioJuliaDocs -> Note: This landing site is under extensive development and will receive frequent updates. -> It is not in a ready state, and is published under GitHub Pages only for testing purposes. +> Note: This landing site is under extensive development and will receive frequent updates. +> It is not in a ready state, and is published under GitHub Pages only for testing purposes. [![GitHub Pages status](https://github.com/BioJulia/BioJuliaDocs/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/BioJulia/BioJuliaDocs/actions/workflows/pages/pages-build-deployment) [![Static Badge](https://img.shields.io/badge/Docs-stable-blue)](https://biojulia.dev/BioJuliaDocs) - -### Enter biojulia.dev/BioJuliaDocs into your search bar for the live GitHub Pages site! - - ## Description -The BioJuliaDocs initiative is an in-development project to produce a landing site for BioJulia similar to [SciMLDocs](https://github.com/SciML/SciMLDocs) (see the production page [here](https://docs.sciml.ai/Overview/stable/)). + +The BioJuliaDocs initiative is an in-development project to produce a landing site for BioJulia +similar to [SciMLDocs](https://github.com/SciML/SciMLDocs) (see the production page [here](https://docs.sciml.ai/Overview/stable/)). ## Testing + The rendered BioJuliaDocs site, for testing purposes, is published online using GitHub Pages at [biojulia.dev/BioJuliaDocs](https://biojulia.dev/BioJuliaDocs). A GitHub action rebuilds the site on every successful pull request. ## Contributing -We appreciate contributions from users/members of the BioJulia commmunity including reporting bugs/typos, fixing issues, and adding new sections. This is a fantastic opportunity to polish one's technical writing skills as well as show off one's skill with BioJulia packages ;) + +We appreciate contributions from users/members of the BioJulia commmunity +including reporting bugs/typos, fixing issues, and adding new sections. +This is a fantastic opportunity to polish one's technical writing skills as well as show off one's skill with BioJulia packages ;) Take a look at the [contributing files](https://github.com/BioJulia/Contributing) detailed contributor and maintainer guidelines, and code of conduct. ## Questions? -Feel free to open a new discussion under the [BioJuliaDocs Discussions](https://github.com/BioJulia/discussions) section. Alternatively, one can chat with the community either via the [Slack](https://julialang.org/slack/) #biology workspace or in the [forums](https://discourse.julialang.org/). +Feel free to open a new discussion under the [BioJuliaDocs Discussions](https://github.com/BioJulia/discussions) section. +Alternatively, one can chat with the community either via the [Slack](https://julialang.org/slack/) #biology workspace +or in the [forums](https://discourse.julialang.org/). -This project is lead by [Michael Persico](mailto:michael.a.persico@gmail.com?subject=[GitHub]) (him/il) as part of a Julia Summer of Code project. Feel free to contact me directly should you wish to address any concerns privately. +This project is lead by [Michael Persico](mailto:michael.a.persico@gmail.com?subject=[GitHub]) (him/il) +as part of a Julia Summer of Code project. +Feel free to contact me directly should you wish to address any concerns privately.