Make the home page pretty

[stevepiercy]

Links of affected pages in Plone Documentation, if any.

https://6.docs.plone.org/

Description

The home page is not great. For inspiration, see:

• https://numpy.org/doc/stable/
• https://pydata-sphinx-theme.readthedocs.io/en/stable/

We can use Sphinx Design to have a card-based layout.

We currently have no User Guide. See #1611 for the plan.

We have solid "Contributing guide" and "Get started", and the beginning of both "Developer guide" and "Conceptual guides".

We need a new page for "Reference guide" that includes links to any reference material, including plone.api and Plone REST API.

[rajatverma311201]

I want to do this task
Could you please tell me how to run this project and make changes
do i have to run make command only ?
or where can i get the guidelines

[stevepiercy]

@rajatverma311201 https://6.docs.plone.org/contributing/documentation/

[boss6825]

@rajatverma311201 are you still working on this?

[stevepiercy]

@boss6825 I unassigned @rajatverma311201, as they never submitted a pull request or pushed any commits for this issue.

[boss6825]

Thanks @stevepiercy
I guess I will be working on this ...
I hope this is not a very complex issue

[stevepiercy]

@boss6825 it's relatively easy. I added that label just now. Feel free to ask questions for clarification of what is desired or if you get stuck.

[stevepiercy]

@boss6825 there are none in this repo, but any styles are inherited from the upstream themes, in order:

• https://github.com/plone/plone-sphinx-theme
• sphinx-book-theme
• pydata-sphinx-theme

But modifying the CSS should not be necessary. Instead you can use https://sphinx-design.readthedocs.io/en/latest/ as noted in the description to accomplish the basic layout and design needed.

For icons, you could either use what Sphinx Design provides or reuse the Pastanaga set from Volto, for starters https://pastanaga.io/icons/.

[boss6825]

so should i fork this repo "https://github.com/plone/plone-sphinx-theme" and work in it to submit a linked PR to the plone-sphinx-theme repo

[stevepiercy]

so should i fork this repo "https://github.com/plone/plone-sphinx-theme" and work in it to submit a linked PR to the plone-sphinx-theme repo

No. That repo merely provides the theme. You should not need to modify any CSS or the theme to accomplish this task. Please review the description again for direction.

[boss6825]

Setting Up the Sphinx Theme for Plone Documentation

I was configuring the Sphinx theme for the documentation, following the Plone Sphinx Documentation Guide.
Here’s a screenshot for reference:

When I executed the command: pip install my_project[docs]

I am getting this error about the caipyrinha package

I think this is because of python version 3.x compatibility issue with caipyrinha
I tried to use the latest version of caipyrinha from its repo but facing the same error

possible solution I can think of is - removing caipyrinha from pyproject.toml

can you provide some insight on this @stevepiercy

[stevepiercy]

I was configuring the Sphinx theme for the documentation, following the Plone Sphinx Documentation Guide.

That's the wrong repo, as I said previously:

No. That repo merely provides the theme.

The issue is in plone/documentation. See Contribute to documentation. Also, FYI, projects usually have a README or other file that says how to contribute, including this one https://github.com/plone/documentation?tab=readme-ov-file#contribute.