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

Clean up getting started page #2566

Closed
wants to merge 2 commits into from

Conversation

dstansby
Copy link
Contributor

The existing getting started page was mostly not-getting-started-content, so I've:

  • Move information about the project to a new "about" page
  • Moved project highlights to the home page
  • Moved the installation page into the getting started page

Open to feedback/suggestions! Will leave as draft for now until I put in a redirect for the installation page (which depends on infastructure in #2555)

@dstansby dstansby added the documentation Improvements to the documentation label Dec 16, 2024
@d-v-b
Copy link
Contributor

d-v-b commented Dec 16, 2024

let me know if this is out of scope, but can we get rid of this "sprinting person" icon, it makes me think we are directing people to an emergency exit:
image

@dstansby
Copy link
Contributor Author

can we get rid of this "sprinting person" icon

👍 - I'll take a look for another icon!

@d-v-b
Copy link
Contributor

d-v-b commented Dec 16, 2024

I wonder if all of the "getting started" content should be on the main page? our main page is just links right now, which to me is a missed opportunity -- people should see content there, not just links. As a template, we could copy pydantic's docs page. Once you get past the promotion of their paid logging service (something we will not emulate) they have a bullet-pointed list explaining what pydantic is for, and then some code examples. I think a comparable structure would be much better than our current landing page.

@dstansby
Copy link
Contributor Author

can we get rid of this "sprinting person" icon

Actually, can I say this is out of scope for this PR? If you open an issue I can do it later though.

@d-v-b
Copy link
Contributor

d-v-b commented Dec 18, 2024

can we get rid of this "sprinting person" icon

Actually, can I say this is out of scope for this PR? If you open an issue I can do it later though.

yes you can say that :) I will open an issue

@dstansby dstansby marked this pull request as ready for review December 18, 2024 13:34
@jhamman
Copy link
Member

jhamman commented Dec 20, 2024

@dstansby - Unfortunately, I've also edited the getting started section in #2568. In fact, I reworked the getting started section into a proper quick-start. How do you want to resolve the pending conflict?

@dstansby
Copy link
Contributor Author

I'm pro this one being reviewed first since it was opened first, and is much smaller and therefore hopefully easier to review.

@jhamman
Copy link
Member

jhamman commented Dec 21, 2024

@dstansby - I ended up pulling your changes from this PR into my larger docs branch. We discussed at the dev meeting today to collect things there for a few days. Feel free to push/suggest edits to that branch if you like.

@dstansby
Copy link
Contributor Author

Okay great - should we close this then?

@jhamman jhamman closed this Dec 21, 2024
@dstansby dstansby deleted the doc-getting-start branch December 21, 2024 17:54
@dstansby dstansby mentioned this pull request Dec 29, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants