Skip to content

feat: Improve Discord community references throughout docs and README#1170

Merged
davidberenstein1957 merged 4 commits into
masterfrom
feat/improve-discord-references
Apr 29, 2026
Merged

feat: Improve Discord community references throughout docs and README#1170
davidberenstein1957 merged 4 commits into
masterfrom
feat/improve-discord-references

Conversation

@davidberenstein1957
Copy link
Copy Markdown
Collaborator

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

  • README: Discord badge + community callout + quick links
  • Navigation: "Join Our Discord" link in main menu
  • Landing page: Discord in quick links table
  • FAQ: Added Discord references for help and bug reporting
  • Code of Conduct: Updated reporting mechanism to include Discord
  • Contributing: Added Discord to questions section + new community help section
  • First tracking tutorial: "Need help?" section with Discord link
  • Visualization guide: Discord in next steps for sharing results

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

  • Docs build successfully: uv run task docs
  • Links verified

🌐 Discord: https://discord.gg/GS9js2XkJR

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.
@davidberenstein1957 davidberenstein1957 requested a review from a team as a code owner April 29, 2026 16:21
@davidberenstein1957 davidberenstein1957 force-pushed the feat/improve-discord-references branch from 4463977 to 7e342f4 Compare April 29, 2026 16:29
Copy link
Copy Markdown
Member

@SaboniAmine SaboniAmine left a comment

Choose a reason for hiding this comment

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

Thanks David!

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.
@davidberenstein1957 davidberenstein1957 merged commit edd49c8 into master Apr 29, 2026
6 checks passed
@davidberenstein1957 davidberenstein1957 deleted the feat/improve-discord-references branch April 29, 2026 17:14
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