Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
2 changes: 1 addition & 1 deletion docs/introduction/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ We believe in the power of open source software. Our core library, [codegen](htt
<Note>
Want to learn more about what we're building? Check out our [getting started
guide](/introduction/getting-started) or join our [community
Slack](https://join.slack.com/t/codegen-community/shared_invite/...).
Slack](https://community.codegen.com).
</Note>
23 changes: 10 additions & 13 deletions docs/introduction/community.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,19 @@ icon: "people-group"
iconType: "solid"
---

import {
COMMUNITY_SLACK_URL,
CODEGEN_SDK_GITHUB_URL,
} from "/snippets/links.mdx";

Join the growing Codegen community! We're excited to have you be part of our journey to make codebase manipulation and transformation more accessible.

<CardGroup cols={2}>
<Card
title="Join our Slack"
icon="slack"
href="https://join.slack.com/t/codegen-community/shared_invite/..."
>
<Card title="Join our Slack" icon="slack" href={COMMUNITY_SLACK_URL}>
Connect with the community, get help, and share your Codegen projects in our
active Slack workspace.
</Card>
<Card
title="GitHub"
icon="github"
href="https://github.com/codegen-sh/codegen-sdk"
>
<Card title="GitHub" icon="github" href={CODEGEN_SDK_GITHUB_URL}>
Star us on GitHub, report issues, submit PRs, and contribute to the project.
</Card>
<Card title="Twitter (X)" icon="twitter" href="https://twitter.com/codegen">
Expand All @@ -43,7 +40,7 @@ Join the growing Codegen community! We're excited to have you be part of our jou

### Slack

Our Slack community is where you can:
Our [Slack community](https://community.codegen.com) is where you can:

- Get help and support
- Share your Codegen projects
Expand All @@ -52,7 +49,7 @@ Our Slack community is where you can:

### GitHub

Codegen is open source and we welcome contributions! On GitHub you can:
Codegen is [open source](https://github.com/codegen-sh/codegen-sdk) and we welcome contributions! On GitHub you can:

- Report issues
- Submit pull requests
Expand All @@ -61,7 +58,7 @@ Codegen is open source and we welcome contributions! On GitHub you can:

### Twitter (X)

Follow us on Twitter/X to:
Follow us on [Twitter/X](https://x.com/codegen) to:

- Get the latest updates
- See community highlights
Expand Down
8 changes: 4 additions & 4 deletions docs/introduction/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,21 @@ iconType: "solid"
</Tip>
</Accordion>
<Accordion title="Can I use Codegen with my existing tools?" icon="screwdriver-wrench">
Yes - [by design](3333/guiding-principles#python-first-composability).
Yes - [by design](/introduction/guiding-principles#python-first-composability).

Codegen works like any other python package. It works alongside your IDE, version control system, and other development tools.
</Accordion>
<Accordion
title="How can I contribute if I'm new to the project?"
icon="hand-holding-heart"
>
Start by trying out Codegen, joining our Slack community, and looking for
issues labeled "good first issue" on GitHub. We welcome contributions to
Start by trying out Codegen, joining our [Slack community](https://community.codegen.com), and looking for
issues labeled "good first issue" on [GitHub](https://github.com/codegen-sh/codegen-sdk). We welcome contributions to
documentation, examples, and code improvements.
</Accordion>
<Accordion title="Is Codegen free to use?" icon="scale-balanced">
Yes, Codegen is [open source](https://github.com/codegen-sh/codegen-sdk) and free to use under the [Apache 2.0
license](https://github.com/codegen-sh/codegen-cli?tab=Apache-2.0-1-ov-file).
license](https://github.com/codegen-sh/codegen-sdk?tab=Apache-2.0-1-ov-file).
You can use it for both personal and commercial projects.
</Accordion>
<Accordion title="Where can I get help if I'm stuck?" icon="life-ring">
Expand Down
10 changes: 7 additions & 3 deletions docs/introduction/how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@ Codegen performs advanced static analysis to build a rich graph representation o
[rustworkx](https://github.com/Qiskit/rustworkx) and has implemented most
language server features from scratch.
</Note>
<Info>
Codegen is open source. Check out the [source
code](https://github.com/codegen-sh/codegen-sdk) to learn more!
</Info>

## The Codebase Graph

At the heart of Codegen is a comprehensive graph representation of your code. When you initialize a `[Codebase](/codebase-sdk/core/codebase)`, it performs static analysis to construct a rich graph structure connecting code elements:
At the heart of Codegen is a comprehensive graph representation of your code. When you initialize a [Codebase](/codebase-sdk/core/codebase), it performs static analysis to construct a rich graph structure connecting code elements:

```python
# Initialize and analyze the codebase
Expand Down Expand Up @@ -71,7 +75,7 @@ Currently, Codegen supports:

We've started with these ecosystems but designed our architecture to be extensible. The graph-based approach provides a consistent interface across languages while handling language-specific details under the hood.

## Join the Journey
## Build with Us

Codegen is just getting started, and we're excited about the possibilities ahead. We enthusiastically welcome contributions from the community, whether it's:

Expand All @@ -82,4 +86,4 @@ Codegen is just getting started, and we're excited about the possibilities ahead
- Adding new transformations
- Improving documentation

Check out our [contribution guide](/contributing) to get involved!
Check out our [community guide](/introduction/community) to get involved!
17 changes: 7 additions & 10 deletions docs/introduction/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ pip install codegen

## Get Started

import {
COMMUNITY_SLACK_URL,
CODEGEN_SDK_GITHUB_URL,
} from "/snippets/links.mdx";

<CardGroup cols={2}>
<Card
title="Get Started"
Expand All @@ -63,18 +68,10 @@ pip install codegen
<Card title="Tutorials" icon="diagram-project" href="/tutorials/at-a-glance">
Learn how to use Codegen for common code transformation tasks.
</Card>
<Card
title="View on GitHub"
icon="github"
href="https://github.com/codegen-sh/codegen-sdk"
>
<Card title="View on GitHub" icon="github" href={CODEGEN_SDK_GITHUB_URL}>
Star us on GitHub and contribute to the project.
</Card>
<Card
title="Join our Slack"
icon="slack"
href="https://join.slack.com/t/codegen-community/shared_invite/..."
>
<Card title="Join our Slack" icon="slack" href={COMMUNITY_SLACK_URL}>
Get help and connect with the Codegen community.
</Card>
</CardGroup>
Expand Down
7 changes: 7 additions & 0 deletions docs/snippets/links.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export const COMMUNITY_SLACK_URL = "https://community.codegen.com";

export const CODEGEN_SDK_GITHUB_URL =
"https://github.com/codegen-sh/codegen-sdk";

export const CODEGEN_SDK_EXAMPLES_GITHUB_URL =
"https://github.com/codegen-sh/codegen-examples";