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.

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

Update documentation to reflect changes in package design #251

Open
ChristianGeng opened this issue Nov 14, 2024 · 0 comments
Open

Update documentation to reflect changes in package design #251

ChristianGeng opened this issue Nov 14, 2024 · 0 comments

Comments

@ChristianGeng
Copy link
Member

Title: Improve API Documentation Structure

Description:

As a follow-up to the redesign of the package in #246, I noticed that the high-level description of the package's architecture is not prominently featured in the API documentation. Specifically, the explanation of the separation between the backend (audbackend.backend) and interface (audbackend.interface) classes is currently located at the end of the API doc.

To improve the readability and usability of the documentation, I propose refactoring the documentation to move this high-level design description to a more prominent location, such as:

  • the top of the Developer Guide
  • the beginning of the Usage Guide

This will help readers quickly understand the overall architecture and design of the package, making it easier for them to navigate the documentation and get started with using the API.

Task:

Refactor the API documentation to move the high-level design description to a more prominent location.

Related Issue: #246

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

No branches or pull requests

1 participant