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

Create a script to automatically generate media properties in the API and frontend #4023

Closed
dhruvkb opened this issue Apr 3, 2024 · 0 comments · Fixed by #3966
Closed

Create a script to automatically generate media properties in the API and frontend #4023

dhruvkb opened this issue Apr 3, 2024 · 0 comments · Fixed by #3966
Assignees
@dhruvkb
Labels
💻 aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🧱 stack: frontend Related to the Nuxt frontend
Milestone
Clearly document ...

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Apr 3, 2024

Description

Create a script that parses models in Django API and types in the Nuxt frontend to generate documentation for these models.

This script should produce documentation pages that can be inferred from the fields and types and also the structure for manually written descriptions.

Actually writing the descriptions will be a separate ticket.
@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API 🧱 stack: frontend Related to the Nuxt frontend labels Apr 3, 2024
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog Apr 3, 2024
@dhruvkb dhruvkb mentioned this issue Apr 3, 2024
Merged
8 tasks
@openverse-bot openverse-bot moved this from 📋 Backlog to 🏗 In Progress in Openverse Backlog Apr 3, 2024
This was referenced Apr 3, 2024
Closed
Closed
Closed
@openverse-bot openverse-bot moved this from 🏗 In Progress to ✅ Done in Openverse Backlog Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dhruvkb dhruvkb

Labels
💻 aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🧱 stack: frontend Related to the Nuxt frontend
Projects
Openverse Backlog
Archived in project
Milestone
Clearly document media properties
Development

Successfully merging a pull request may close this issue.

Implement media properties documentation for the API and frontend WordPress/openverse
1 participant
@dhruvkb