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

docs: Documentation overhaul #2558

Open
edgarrmondragon opened this issue Jul 20, 2024 · 1 comment
Open

docs: Documentation overhaul #2558

edgarrmondragon opened this issue Jul 20, 2024 · 1 comment
Assignees
@edgarrmondragon
Labels
Documentation Improvements or additions to documentation valuestream/SDK

Comments

@edgarrmondragon
Copy link
Collaborator

edgarrmondragon commented Jul 20, 2024 •
edited
Loading

Documentation type

How-to guides

Description

overhaul /ō″vər-hôl′, ō′vər-hôl″/
transitive verb

To examine or go over carefully for needed repairs.
@edgarrmondragon edgarrmondragon added Documentation Improvements or additions to documentation valuestream/SDK labels Jul 20, 2024
@edgarrmondragon
Copy link
Collaborator Author

I like the landing docs page of sphinx-autoapi:

Screenshot 2024-07-20 at 2 42 34 p m

https://sphinx-autoapi.readthedocs.io/en/latest/.

Reminds of https://diataxis.fr/.

@edgarrmondragon edgarrmondragon 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

@edgarrmondragon edgarrmondragon

Labels
Documentation Improvements or additions to documentation valuestream/SDK
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@edgarrmondragon