Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.19 KB

README.md

File metadata and controls

43 lines (30 loc) · 2.19 KB

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 Static Badge

Description

The BioJuliaDocs initiative is an in-development project to produce a landing site for BioJulia similar to SciMLDocs (see the production page here).

Testing

The rendered BioJuliaDocs site, for testing purposes, is published online using GitHub Pages at biojulia.dev/BioJuliaDocs. A GitHub action rebuilds the site on every successful pull request.

To deploy the site locally:

# Make sure you are within or are pointing to the the docs/ folder
using Documenter, LiveServer
include("make.jl")
serve(dir="build")

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

Take a look at the contributing files detailed contributor and maintainer guidelines, and code of conduct.

Questions?

Feel free to open a new discussion under the BioJuliaDocs Discussions section. Alternatively, one can chat with the community either via the Slack #biology workspace or in the forums.

This project is lead by Michael Persico (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.