diff --git a/docs/introduction/about.mdx b/docs/introduction/about.mdx index 24e7a5dba..720a4c9f1 100644 --- a/docs/introduction/about.mdx +++ b/docs/introduction/about.mdx @@ -67,5 +67,5 @@ We believe in the power of open source software. Our core library, [codegen](htt 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). diff --git a/docs/introduction/community.mdx b/docs/introduction/community.mdx index fd6a9e95f..658f6b01e 100644 --- a/docs/introduction/community.mdx +++ b/docs/introduction/community.mdx @@ -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. - + Connect with the community, get help, and share your Codegen projects in our active Slack workspace. - + Star us on GitHub, report issues, submit PRs, and contribute to the project. @@ -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 @@ -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 @@ -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 diff --git a/docs/introduction/faq.mdx b/docs/introduction/faq.mdx index 2572ef84f..6847bc75a 100644 --- a/docs/introduction/faq.mdx +++ b/docs/introduction/faq.mdx @@ -37,13 +37,13 @@ iconType: "solid" 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. 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. diff --git a/docs/introduction/how-it-works.mdx b/docs/introduction/how-it-works.mdx index 179785b75..9ce1f8445 100644 --- a/docs/introduction/how-it-works.mdx +++ b/docs/introduction/how-it-works.mdx @@ -14,6 +14,10 @@ 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. + + Codegen is open source. Check out the [source + code](https://github.com/codegen-sh/codegen-sdk) to learn more! + ## The Codebase Graph @@ -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: @@ -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](/introduction/community) to get involved! +Check out our [community guide](/introduction/community) to get involved! diff --git a/docs/introduction/overview.mdx b/docs/introduction/overview.mdx index 45e6c0973..5805cb976 100644 --- a/docs/introduction/overview.mdx +++ b/docs/introduction/overview.mdx @@ -52,6 +52,11 @@ pip install codegen ## Get Started +import { + COMMUNITY_SLACK_URL, + CODEGEN_SDK_GITHUB_URL, +} from "/snippets/links.mdx"; + Learn how to use Codegen for common code transformation tasks. - + Star us on GitHub and contribute to the project. - + Get help and connect with the Codegen community. diff --git a/docs/snippets/links.mdx b/docs/snippets/links.mdx new file mode 100644 index 000000000..3ec8cb712 --- /dev/null +++ b/docs/snippets/links.mdx @@ -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";