Open Systems Pharmacology
ForumSetup
v10
v10
  • Introduction
  • Open Systems Pharmacology Suite Manual & Copyright
  • How to Contribute
  • Mechanistic Modeling of Pharmacokinetics and Dynamics
    • Modeling Concepts
      • PBPK Modeling - Systems Biology
      • PK and PD Modeling
      • Principles of PBPK Modeling
      • Expression Data for PBPK Modeling
      • Modeling of Proteins
      • PD and Reaction Network Modeling
  • Open Systems Pharmacology Suite
    • Modules, Philosophy, and Building Blocks
    • Getting Started
  • Working with PK-Sim
    • PK-Sim Documentation
      • Quick Guide‌
      • Options
      • Projects
      • Creating Individuals
      • Creating Populations
      • Expression Data
      • Compounds: Definition and Work Flows
      • Compounds: Defining Inhibition/Induction Processes
      • Administration Protocols
      • Events
      • Formulations
      • Simulations
      • Importing and Exporting Project Data and Models
      • Conversion of Projects from Previous Version
      • Command Line Interface - CLI
  • Working with MoBi
    • MoBi‌ Documentation
      • First Steps
      • The Building Block Concept
      • Model Building and Model Components
      • Setting up a Simulation
      • Simulation Results
      • Diagrams Overview
      • Tools
      • Reuse of Project Information from Previous Versions
  • Shared Tools and Example Workflows
    • Features of Tables
    • Chart Component
    • Comparison of Building Blocks
    • Parameter Identification
    • Sensitivity Analysis
    • Import and Edit of Observed Data
    • Default, Display and Base Units
    • Reporting
    • Working Journal
    • History Manager and History Reporting‌
    • Setting up a Reaction Network‌
    • Setting up a Drug-Drug Interaction in PK-Sim‌
    • Qualification‌
  • Working with R‌
    • ospsuite-R Documentation
  • Appendix
    • Appendix
    • OSP Suite Fact Sheet
  • References
    • References
Powered by GitBook
On this page
  • Requirements
  • Edit of existing documents
  • Adding new content
  • Rich content
  • Note, hints and callout

How to Contribute

PreviousOpen Systems Pharmacology Suite Manual & CopyrightNextModeling Concepts

Last updated 3 years ago

Welcome to the Contributor guide!

The documentation for the Open Systems Pharmacology Suite is open source and hosted on GitHub. Despite all the efforts to maintain and update the documentation, there will always be small grammar and spelling errors sliding through the cracks as well as sections of the documentation that are not clear enough, missing or outdated.

While you can create issues in the to report those errors or omissions, it will often be faster and easier to submit your edits directly to be reviewed by the documentation core team.

This guide aims at describing the workflow to contribute to the documentation.

Requirements

The only requirement to contribute to the documentation is to have a GitHub account. If you do not have an account, you can for free in a few seconds.

Edit of existing documents

Each page available on the docs website corresponds to a file hosted on GitHub that can be edited.

Clicking on the Edit on GitHub button will take you to the source file on GitHub.

Next, click the pencil icon, as shown in the following figure to edit the article.

If the pencil icon is grayed out, you need to login to your GitHub account.

Make your changes in the web editor. Formatting of the documentation is based on the so called Markdown syntax. The description of this lightweight and easy-to-use syntax can be found . You can click the Preview changes tab to check formatting of your change.

Once you are done with your changes, scroll to the bottom of the page. Enter a title and description for your edits and click Propose file change as shown in the following figure:

Now that you have proposed your changes, you need to ask the documentation core team to incorporate them into the documentation. This is done using something called a pull request. When you clicked on Propose file change in the figure above (and on Create pull request after that), you should have been taken to a new page that looks like the following figure:

Review the title and the description for the pull request, and then click Create pull request.

That's it! The documentation core team will be notified and review your changes. You may get some feedback requesting changes if you made larger changes.

Adding new content

The process is slightly more complicated as you need to create a new content file and incorporate it into the existing documentation. We would be happy to help you do that if you need some support. Simply open an issue in the docs repo describing what you want to add and where and we'll get in touch with you.

Rich content

Note, hints and callout

Provides a great way to bring the reader's attention to specific elements.

By surrounding your text with { % hint style="xxx" %} and { % endhint %}, a visual clue will be created for your content, making it pop out

For example: using the style note, we can create the following visual element

This is a note

Available styles are:

  • tip

  • note

  • warning

  • info

docs.open-systems-pharmacology.org
docs repository
create one
here
Propose file change
Open pull request
Edit on GitHub
Edit