Skip to content

Commit 377e180

Browse files
jayhackcodegen-botcodegen-team
authored
docs: add proper slack link (#85)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [ ] I have updated the documentation or added new documentation as needed - [ ] I have read and agree to the [Contributor License Agreement](../CLA.md) --------- Co-authored-by: codegen-bot <[email protected]> Co-authored-by: Codegen Team (Internal) <[email protected]>
1 parent 53e7e8a commit 377e180

File tree

6 files changed

+34
-29
lines changed

6 files changed

+34
-29
lines changed

docs/introduction/about.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,5 +67,5 @@ We believe in the power of open source software. Our core library, [codegen](htt
6767
<Note>
6868
Want to learn more about what we're building? Check out our [getting started
6969
guide](/introduction/getting-started) or join our [community
70-
Slack](https://join.slack.com/t/codegen-community/shared_invite/...).
70+
Slack](https://community.codegen.com).
7171
</Note>

docs/introduction/community.mdx

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,19 @@ icon: "people-group"
55
iconType: "solid"
66
---
77

8+
import {
9+
COMMUNITY_SLACK_URL,
10+
CODEGEN_SDK_GITHUB_URL,
11+
} from "/snippets/links.mdx";
12+
813
Join the growing Codegen community! We're excited to have you be part of our journey to make codebase manipulation and transformation more accessible.
914

1015
<CardGroup cols={2}>
11-
<Card
12-
title="Join our Slack"
13-
icon="slack"
14-
href="https://join.slack.com/t/codegen-community/shared_invite/..."
15-
>
16+
<Card title="Join our Slack" icon="slack" href={COMMUNITY_SLACK_URL}>
1617
Connect with the community, get help, and share your Codegen projects in our
1718
active Slack workspace.
1819
</Card>
19-
<Card
20-
title="GitHub"
21-
icon="github"
22-
href="https://github.com/codegen-sh/codegen-sdk"
23-
>
20+
<Card title="GitHub" icon="github" href={CODEGEN_SDK_GITHUB_URL}>
2421
Star us on GitHub, report issues, submit PRs, and contribute to the project.
2522
</Card>
2623
<Card title="Twitter (X)" icon="twitter" href="https://twitter.com/codegen">
@@ -43,7 +40,7 @@ Join the growing Codegen community! We're excited to have you be part of our jou
4340

4441
### Slack
4542

46-
Our Slack community is where you can:
43+
Our [Slack community](https://community.codegen.com) is where you can:
4744

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

5350
### GitHub
5451

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

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

6259
### Twitter (X)
6360

64-
Follow us on Twitter/X to:
61+
Follow us on [Twitter/X](https://x.com/codegen) to:
6562

6663
- Get the latest updates
6764
- See community highlights

docs/introduction/faq.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ iconType: "solid"
3737
title="How can I contribute if I'm new to the project?"
3838
icon="hand-holding-heart"
3939
>
40-
Start by trying out Codegen, joining our Slack community, and looking for
41-
issues labeled "good first issue" on GitHub. We welcome contributions to
40+
Start by trying out Codegen, joining our [Slack community](https://community.codegen.com), and looking for
41+
issues labeled "good first issue" on [GitHub](https://github.com/codegen-sh/codegen-sdk). We welcome contributions to
4242
documentation, examples, and code improvements.
4343
</Accordion>
4444
<Accordion title="Is Codegen free to use?" icon="scale-balanced">
4545
Yes, Codegen is [open source](https://github.com/codegen-sh/codegen-sdk) and free to use under the [Apache 2.0
46-
license](https://github.com/codegen-sh/codegen-cli?tab=Apache-2.0-1-ov-file).
46+
license](https://github.com/codegen-sh/codegen-sdk?tab=Apache-2.0-1-ov-file).
4747
You can use it for both personal and commercial projects.
4848
</Accordion>
4949
<Accordion title="Where can I get help if I'm stuck?" icon="life-ring">

docs/introduction/how-it-works.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Codegen performs advanced static analysis to build a rich graph representation o
1414
[rustworkx](https://github.com/Qiskit/rustworkx) and has implemented most
1515
language server features from scratch.
1616
</Note>
17+
<Info>
18+
Codegen is open source. Check out the [source
19+
code](https://github.com/codegen-sh/codegen-sdk) to learn more!
20+
</Info>
1721

1822
## The Codebase Graph
1923

@@ -71,7 +75,7 @@ Currently, Codegen supports:
7175

7276
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.
7377

74-
## Join the Journey
78+
## Build with Us
7579

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

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

85-
Check out our [contribution guide](/introduction/community) to get involved!
89+
Check out our [community guide](/introduction/community) to get involved!

docs/introduction/overview.mdx

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ pip install codegen
5252

5353
## Get Started
5454

55+
import {
56+
COMMUNITY_SLACK_URL,
57+
CODEGEN_SDK_GITHUB_URL,
58+
} from "/snippets/links.mdx";
59+
5560
<CardGroup cols={2}>
5661
<Card
5762
title="Get Started"
@@ -63,18 +68,10 @@ pip install codegen
6368
<Card title="Tutorials" icon="diagram-project" href="/tutorials/at-a-glance">
6469
Learn how to use Codegen for common code transformation tasks.
6570
</Card>
66-
<Card
67-
title="View on GitHub"
68-
icon="github"
69-
href="https://github.com/codegen-sh/codegen-sdk"
70-
>
71+
<Card title="View on GitHub" icon="github" href={CODEGEN_SDK_GITHUB_URL}>
7172
Star us on GitHub and contribute to the project.
7273
</Card>
73-
<Card
74-
title="Join our Slack"
75-
icon="slack"
76-
href="https://join.slack.com/t/codegen-community/shared_invite/..."
77-
>
74+
<Card title="Join our Slack" icon="slack" href={COMMUNITY_SLACK_URL}>
7875
Get help and connect with the Codegen community.
7976
</Card>
8077
</CardGroup>

docs/snippets/links.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
export const COMMUNITY_SLACK_URL = "https://community.codegen.com";
2+
3+
export const CODEGEN_SDK_GITHUB_URL =
4+
"https://github.com/codegen-sh/codegen-sdk";
5+
6+
export const CODEGEN_SDK_EXAMPLES_GITHUB_URL =
7+
"https://github.com/codegen-sh/codegen-examples";

0 commit comments

Comments
 (0)