Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Biojulia update #7

Merged
merged 2 commits into from
Jul 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,35 @@
# <img src="./sticker.svg" width="30%" align="right" /> 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.

[![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)


### Enter m-persic.github.io/BioJuliaDocs into your search bar for the live GitHub Pages site!
> 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)

## 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 [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 ;)

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/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/).

This project is lead by [Michael Persico](mailto:[email protected]?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.
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:[email protected]?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.
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ makedocs(
)

deploydocs(
repo = "https://github.com/M-PERSIC/BioJuliaDocs.git"
repo = "https://github.com/BioJulia/BioJuliaDocs.git"
)
Loading