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

Move python and cli reference to separate doc pages #91

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Conversation

mslw
Copy link
Contributor

@mslw mslw commented Oct 9, 2023

This helps tidy up the home page (only lists of commands, no table) and navigation bar (proper sections for High-level API commands and Command line reference). There are now 3 files instead of 1, but I think it's worth it. Closes #90

Headings and structure (although not file names) follow datalad-next docs.

Before:
Screenshot from 2023-10-09 16-52-06

After:
Screenshot from 2023-10-09 17-39-39

Changes not included here but worth considering to make things even leaner: remove sub-headings below API and keep just the list; rename "High-level api" to "Python api", keep the list only 1 level deep (instead of 2) -- however these are easy to tune after starting a new project.

This helps tidy up the home page (only lists of commands, no table)
and navigation bar (proper sections for High-level API commands and
Command line reference).
Copy link
Member

@adswa adswa left a comment

Choose a reason for hiding this comment

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

I find this organization more visually pleasing 👍

Copy link
Member

@jsheunis jsheunis left a comment

Choose a reason for hiding this comment

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

Looks good.

Regarding:

remove sub-headings below API and keep just the list; rename "High-level api" to "Python api",

I think both are good ideas.

@adswa adswa merged commit 3faf449 into main Oct 10, 2023
3 checks passed
@adswa adswa deleted the docs-sections branch October 10, 2023 05:55
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.

Restructure docs
3 participants