Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve edx-platform docs and discoverability #35014

Open
Tracked by #35144
robrap opened this issue Jun 20, 2024 · 1 comment
Open
Tracked by #35144

Improve edx-platform docs and discoverability #35014

robrap opened this issue Jun 20, 2024 · 1 comment
Assignees
@farhan

Comments

@robrap
Copy link
Contributor

robrap commented Jun 20, 2024

This is a follow-up to #33327, which made app-level docs part of the edx-platform readthedocs output.

Improvement ideas:

  • Add app-level READMEs
  • Add top-level index page to make discovery of app-level docs easier.
  • Eventually update OEP-19 with best practices for exposing these for a repo based on experience with edx-platform.
@irtazaakram irtazaakram moved this to 🔖 Ready in Aximprovements Team Jun 27, 2024
@farhan
Copy link
Contributor

farhan commented Jul 11, 2024

OEO-19 doc

@robrap robrap mentioned this issue Jul 29, 2024
Open
@farhan farhan self-assigned this Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@farhan farhan

Labels
None yet
Projects
Aximprovements Team
Status: 🔖 Ready
Milestone
No milestone
Development

No branches or pull requests
2 participants
@robrap @farhan