feat: Improve Discord community references throughout docs and README#1170
Merged
Conversation
Add Discord community links to key documentation and README sections to make it easier for users to get help, contribute, and connect with the community: - README: Add Discord badge and community callout box - Navigation menu: Add "Join Our Discord" link - Documentation landing page: Add Discord to quick links table - FAQ: Add Discord references for help and bug reporting - Code of Conduct: Update reporting mechanism to include Discord - Contributing guide: Add Discord to question section and add community help section - First tracking tutorial: Add "Need help?" section with Discord link - Visualization guide: Add Discord to next steps for sharing results Moved Discord reference from Cloud API guide (overly technical) to Visualization guide (team/community-oriented) for better fit. This makes Discord visible at multiple entry points: README → landing page → tutorials → guides → FAQ → community pages.
4463977 to
7e342f4
Compare
Add dedicated section on docs landing page linking to: - GitHub contributors list - Citation/Zenodo for research use - Project partners and supporters Makes it easy for users to discover and credit CodeCarbon contributors.
This change simplifies the theme configuration by removing the custom_dir entry, which is no longer needed.
The custom_dir: overrides was pointing to an empty directory, causing zensical build to fail with 'No such file or directory' error. Remove it since no template overrides are needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added Discord community links to key documentation and README sections to make it easier for users to get help, contribute, and connect with the community.
Changes
Design decision
Moved Discord reference from Cloud API guide (overly technical) to Visualization guide (team/community-oriented) for better fit. Discord now visible at multiple entry points throughout docs.
Testing
uv run task docs🌐 Discord: https://discord.gg/GS9js2XkJR