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

docs: add organization README #1

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

fubuloubu
Copy link
Member

What I did

fixes: #

How I did it

How to verify it

Checklist

  • All changes are completed
  • New test cases have been added
  • Documentation has been updated

profile/README.md Outdated Show resolved Hide resolved
profile/README.md Outdated Show resolved Hide resolved

We are [ApeWorX LTD](https://apeworx.io), a collective of infrastructure engineers, smart contract devs, and Web3-curious folks,
building the next generation of Python tooling and infrastructure to support your next great idea.
Our suite of open source projects and developer tools, educational conten, and hosted services aims to guide you along your
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we no longer adhering the md style rule of 1 sentence per line? It's cool if we aren't but just wondering.

profile/README.md Outdated Show resolved Hide resolved

<!-- Read our [academic platform](https://academy.apeworx.io/) will help you master Ape Framework with tutorials and challenges. -->

## Contributing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this part just link to the CONRTIBUTING guide? We can make a some of these edits there


Visit our [technical documentation hub](https://docs.apeworx.io) to get a deeper understanding of Ape, Silverback and our other OSS packages.

<!-- Read our [academic platform](https://academy.apeworx.io/) will help you master Ape Framework with tutorials and challenges. -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- Read our [academic platform](https://academy.apeworx.io/) will help you master Ape Framework with tutorials and challenges. -->
<!-- Read our [academic platform](https://academy.apeworx.io/) to help master the Ape Framework with tutorials and challenges. -->


It is also useful to have this token for local development as some features of Ape communicate with GitHub, and may rate limit you otherwise without it.

### Displaying the Docs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing newline:

Suggested change
### Displaying the Docs
### Displaying the Docs

fubuloubu and others added 3 commits September 17, 2024 14:45
Co-authored-by: antazoey <jules@apeworx.io>
Co-authored-by: antazoey <jules@apeworx.io>
Co-authored-by: antazoey <jules@apeworx.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants