Skip to content

feat: added init command to docs#62

Open
AhtishamShahid wants to merge 2 commits intoopenedx:mainfrom
AhtishamShahid:ahtisham/add-init-in-docs
Open

feat: added init command to docs#62
AhtishamShahid wants to merge 2 commits intoopenedx:mainfrom
AhtishamShahid:ahtisham/add-init-in-docs

Conversation

@AhtishamShahid
Copy link
Copy Markdown
Contributor

This pull request adds important instructions to the README.rst to help users initialize the notifications plugin in both local and development environments.

Usage documentation update:

  • Added code examples for initializing the notifications plugin using tutor local do init --limit=notifications and tutor dev do init --limit=notifications to clarify setup steps for different environments.

@AhtishamShahid AhtishamShahid requested review from ayub02, Copilot and sarina and removed request for Copilot March 19, 2026 14:07
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the plugin’s README usage docs to include initialization commands for the notifications plugin in both local and dev Tutor environments.

Changes:

  • Fixed formatting/whitespace around the “Notifications & Preferences” documentation link.
  • Added tutor local do init --limit=notifications and tutor dev do init --limit=notifications examples to the Usage section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Ty Hob / Brian Mesick <112640379+bmtcril@users.noreply.github.com>
@AhtishamShahid AhtishamShahid force-pushed the ahtisham/add-init-in-docs branch from daf52bb to b19e53e Compare March 27, 2026 09:10
@sarina
Copy link
Copy Markdown
Contributor

sarina commented Mar 27, 2026

I was requested to review this PR, but I'm not a Tutor maintainer/contributor. @bmtcril can you finish review?

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.

4 participants