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.

Sign up for GitHub

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

Jump to bottom

Docs/readme revision #22

Merged
merged 2 commits into from
Jul 17, 2024
Merged

Docs/readme revision #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbbcc85
docs: edit readme
Jul 17, 2024
97a5188
docs: edit contrib
Jul 17, 2024
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
6 changes: 3 additions & 3 deletions CONTRIBUTE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ git clone https://github.com/genai-engineering-thailand/genai-engineering-thaila
Create a new branch for your contribution.

```sh
git checkout -b feature/your-feature
git checkout -b docs/your-docs
```

### Making Changes 🛠️
Expand All @@ -32,13 +32,13 @@ git checkout -b feature/your-feature
1. Commit your changes with a descriptive commit message. We encourage you to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

```sh
git commit -m "feat: add ABC content to docs folder"
git commit -m "docs: add ABC content to docs folder"
```

2. Push your changes to your forked repository.

```sh
git push origin feature/your-feature
git push origin docs/your-docs
```

### Creating a Pull Request (PR) 📥
Expand Down
5 changes: 1 addition & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ make serve

## Knowledge Sharing

Our community has a regular engineering deep dive session. You can find out events schedule from this xx page.
Our community has a regular engineering deep dive session.

If you missed our live streaming, here are [recordings and materials](./docs/knowledge-sharing/content_index.md).

Expand All @@ -35,8 +35,6 @@ If you missed our live streaming, here are [recordings and materials](./docs/kno
Find out a collection of useful curation portals [here](./docs/awesome_curation.md).


[comment]: # (--8<-- [start:join-our-community])

## Join our community

Let's connect and make our community stay alive. Please read our [contribution guidelines](CONTRIBUTE.md) about detailed workflow. For general questions or updates, public discussions and event appointments, please join our community.
Expand All @@ -45,4 +43,3 @@ Let's connect and make our community stay alive. Please read our [contribution g

All contributions are greatly appreciated :heart:

[comment]: # (--8<-- [end:join-our-community])
23 changes: 20 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
--8<--
README.md:join-our-community
--8<--

## Knowledge Sharing

Our community has a regular engineering deep dive session.

If you missed our live streaming, here are [recordings and materials](./knowledge-sharing/content_index.md).


## Awesome Curation

Find out a collection of useful curation portals [here](./awesome_curation.md).


## Join our community

Let's connect and make our community stay alive. For general questions or updates, public discussions and event appointments, please check our Discord.

[![](https://img.shields.io/badge/Facebook-1877F2?style=for-the-badge&logo=facebook&logoColor=white)](404) [![](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](404)

All contributions are greatly appreciated :heart:
Loading