Skip to content

Refactoring and improvements to bot contributing docs#1627

Open
wookie184 wants to merge 3 commits into
mainfrom
wookie/improve-contributing-docs
Open

Refactoring and improvements to bot contributing docs#1627
wookie184 wants to merge 3 commits into
mainfrom
wookie/improve-contributing-docs

Conversation

@wookie184

@wookie184 wookie184 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Rewrite of a bunch of the bot contributing documentation, with some other changes here and there.

Open to any suggestions (including reverting parts/adding bits if it feels too concise now).

Changes:

  • Updated "creating bot account" guide to reflect changes to Dev Portal
    • Documented permissions needed
    • Documented permissions + intents directly in bot.md as well so they are harder to miss
  • Combined "forking" and "cloning" guide into one to consolidate information.
  • In docker guide
    • Added potential error from running with Apple Silicon
    • docker-compose -> docker compose
  • Removed installing-project-dependencies.md
    • uv sync doesn't deserve a whole page.
    • Contained a broken link with pycharm instructions.
  • Fixed instructions for getting discord IDs in obtaining-discord-ids.md
  • Removed setting-test-server-and-bot-account.md as it is a duplicate of creating-bot-account.md and obtaining-discord-ids.md
  • Removed Gitpod suggestion for lancebot (it is now a renamed 'AI' company with no free tier afaict)
  • Rewrote a bunch of bot.md to be more concise and hopefully clearer.

@netlify

netlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Deploy Preview for pydis-static ready!

Name Link
🔨 Latest commit c0e69e6
🔍 Latest deploy log https://app.netlify.com/projects/pydis-static/deploys/6a3d730664277d00086ef235
😎 Deploy Preview https://deploy-preview-1627--pydis-static.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coveralls

coveralls commented Jun 23, 2026

Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — wookie/improve-contributing-docs into main

Comment thread pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md Outdated
@@ -102,6 +103,8 @@ $ uv run task configure
Once the script has finished running, you'll notice the creation of a new file called `.env.server` at your project's root directory.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

It might be worth adding something about manually setting it to a community if that step of the script fails.

@wookie184 wookie184 force-pushed the wookie/improve-contributing-docs branch from cfbedbd to c0e69e6 Compare June 25, 2026 18:27
@wookie184 wookie184 changed the title Refactoring and improvements to contributing docs Refactoring and improvements to bot contributing docs Jun 25, 2026
@wookie184 wookie184 marked this pull request as ready for review June 25, 2026 18:44
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.

3 participants