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

wip docs: Restructure docs #988

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

MarcoGorelli
Copy link
Member

I think there's too many pages in the docs at the moment

I also don't really like the landing page for the api docs

It looks a bit shorter and simpler now:

image

What type of PR is this? (check all applicable)

  • 💾 Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • 🔧 Optimization
  • 📝 Documentation
  • ✅ Test
  • 🐳 Other

Related issues

  • Related issue #
  • Closes #

Checklist

  • Code follows style guide (ruff)
  • Tests added
  • Documented the changes

If you have comments or can explain your changes, please do so below.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 17, 2024
@MarcoGorelli MarcoGorelli force-pushed the restructure-docs branch 3 times, most recently from 2ba2f1a to 1531cbd Compare September 17, 2024 15:50
@MarcoGorelli MarcoGorelli changed the title docs: Restructure docs wip docs: Restructure docs Sep 17, 2024
Copy link
Member

Choose a reason for hiding this comment

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

Should this be out of the coming_from_pandas section?

Copy link
Member Author

Choose a reason for hiding this comment

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

in my head I was thinking "if you're coming from pandas, rest assured, this won't make your pandas code slower", but idk, writing docs is so hard

@luke396
Copy link
Member

luke396 commented Sep 18, 2024

Should we relocate the typing page or make it more accessible?

I often forget that we have a typing page, even though it's linked on the homepage, as one of our main features.

(And it appears to be handwritten, not directly generated.)

{ADC37F54-1A1C-4562-8769-F8B2B28A5DB0}

@MarcoGorelli MarcoGorelli mentioned this pull request Sep 20, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants