Skip to content

Commit

Permalink
fix: revise handbook introduction and contribute guidelines for clari…
Browse files Browse the repository at this point in the history
…ty and better onboarding experience

fix: lint files
  • Loading branch information
jjjermiah committed Oct 30, 2024
1 parent f819f89 commit 2c958fb
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 17 deletions.
24 changes: 20 additions & 4 deletions docs/General/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@
# Home

## Draft Structure:
## What is the handbook?

<iframe src="https://miro.com/app/live-embed/uXjVKwSe31w=/?moveToViewport=-3635,688,2780,1134&embedId=279072143427" frameborder="0" scrolling="no" allow="fullscreen; clipboard-read; clipboard-write" allowfullscreen></iframe>
The handbook is a collection of resources for the BHK Lab. It is intended to be a resource for all BHK Lab members to learn about the lab, its projects, and how to get involved.

{%
include-markdown "../../README.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
%}

## Development Documentation
## Want to Contribute?

If you're interested in contributing to the BHK Lab Handbook, we encourage
you to check out our **[Contributing Section][contributing-to-the-lab-handbook]**.

Whether you're looking to [report an issue][submitting-issues],
[add new content][adding-content], or
[suggest an enhancement][submitting-issues], the [Contributing Section][contributing-to-the-lab-handbook] has all
the resources you need to get started. Your contributions help make this
handbook a valuable tool for the entire lab community!

!!! warning "This handbook is under active development and open-source!"

See [Contributing to the Lab Handbook][contributing-to-the-lab-handbook] for more information.
Visit the [GitHub repository](https://github.com/bhklab/handbook) to
see the latest updates and contribute to the project.

## Miro Board:

<iframe src="https://miro.com/app/live-embed/uXjVKwSe31w=/?moveToViewport=-3635,688,2780,1134&embedId=279072143427" frameborder="0" scrolling="no" allow="fullscreen; clipboard-read; clipboard-write" allowfullscreen></iframe>
2 changes: 1 addition & 1 deletion docs/contributing/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: Contributing
nav:
- index.md
- prerequisites.md
- submitting_issues.md
- adding_content.md
- ...
- reviews.md
- merging_pr.md
- release_deployment.md
- submitting_issues.md
- changelog.md
2 changes: 0 additions & 2 deletions docs/contributing/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
{%
include-markdown "../../CHANGELOG.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
%}
74 changes: 68 additions & 6 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,74 @@
# [Contributing to the Lab Handbook](#contributing-to-the-lab-handbook)

Thank you for your interest in contributing to the Lab Handbook! This section will guide you through the process of setting up your development environment, installing dependencies, and building the documentation.
*Thank you for your interest in contributing to the Lab Handbook!*

## Getting Started
This section will guide you through the process of setting up your
development environment, installing dependencies, and building the documentation.

Before you begin, you should have the following:
Below are some common questions to help you find the right guidance for specific
contributing tasks.

1. A [GitHub](https://github.com/) account.
2. [`pixi`](https://pixi.sh/) installed.
---

See [Prerequisites][prerequisites] for more information.
## Where should I start if I want to contribute?

If you’re new to contributing, start with the **[Prerequisites](prerequisites.md)**
page to set up your environment and install necessary dependencies.

---

## How do I submit an issue for a problem I found?

If you’ve identified an issue, refer to the
**[Submitting Issues](submitting_issues.md)** page. <br> It provides details on
how to use our issue templates and submit effective bug reports or feature requests.

---

## How can I add new content to the handbook?

To learn about adding or editing content, check out the
**[Adding Content](adding_content.md)** page. <br> This guide explains how to
structure and format your additions to fit seamlessly into the handbook.


---

## What steps are involved in the review process?

The **[Reviewing a Contribution](reviews.md)** page outlines the review process,
including best practices for constructive feedback and steps for both reviewers
and contributors.

---

## Where can I view all the changes made to the handbook?

To see recent updates and changes to the documentation, visit the
**[Changelog](changelog.md)** page for a record of all documented changes.

---

By following these resources, you'll have everything you need to contribute
effectively to the Lab Handbook. If you have additional questions, feel free
to reach out to the maintainers or submit a question through the
**[Submitting Issues](submitting_issues.md)** page.

___

# For Maintainers

## What should I know about merging pull requests?

For guidance on merging contributions, visit the **[Merging PR](merging_pr.md)**
page. <br> It explains our review process, how to address review comments, and
merge a PR successfully.

---

## How do I prepare for releasing and deploying changes?

Check out the [Release & Deployment](release_deployment.md) page to learn
about our release procedures, automated workflows, and deployment to GitHub Pages.

---
4 changes: 0 additions & 4 deletions docs/onboarding/introduction.md
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
# Onboarding Introduction

## What is the handbook?

The handbook is a collection of resources for the BHK Lab. It is intended to be a resource for all BHK Lab members to learn about the lab, its projects, and how to get involved.

0 comments on commit 2c958fb

Please sign in to comment.