-
-
Notifications
You must be signed in to change notification settings - Fork 172
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
Change home page UI #1875
Change home page UI #1875
Conversation
Thanks for submitting your first pull request! You are awesome! 🤗 |
@stevepiercy could you review this? |
As per #1787 (comment) added a reference guide page, not much in it but it's a start |
@Manas-Kenge I'm super pleased with the result of your work. Thank you! Would you please delete the text "This documentation is for:" and its bullet points? I think it's just visual noise and not particularly helpful. Since this is a Big Freaking Deal™, I've requested feedback from the broader community. There may be a lot of discussion and opinions. I'll respond to feedback from other people, and provide further direction, if needed. I'll do a more thorough review when I have more time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Thanks for the feedback, @stevepiercy ! I've removed that section. Let me know if there's anything else. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Manas-Kenge thank you so much for taking this on! I'm seeing the future unfold before my eyes, as I envisioned in plone/Products.CMFPlone#4097.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@stevepiercy I made changes as per your request but user guide's description needs your attention. |
# Reference guide | ||
|
||
This reference guide details application programming interfaces (APIs), functions, modules, and objects included in Plone, describing what they are and what they do. | ||
Its audience is primarily developers of Plone and its projects and add-ons. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stevepiercy I'm not sure this structure is right. Just because a section of docs covers an API doesn't mean that it's all reference. The lists of endpoints / functions are reference but there's also conceptual and how-to material in there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a way to solve this by ignoring plone.restapi
's and plone.api
's index.md
files and using custom ones in plone/documentation
. It's hard to describe without an example, but it works.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK this is now ready for review. Please take a look at the pull request preview.
@Manas-Kenge I move at the speed of unpaid open source software volunteers. Thanks for your work and patience. I will give this a thorough review soon. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking great. I have a few suggestions, and I want to try to build it locally and test out my assumptions about the toctree and sphinx-reredirects
usage before merging.
I love it, good work! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything looks good, except the submodule.
I need to work on the two indices before merging.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
…rom `install/index.md`
…t to the Volto User Manual
- Add a hidden toctree to keep the same list hidden on the page, but appear in the navigation - Configure the navigation items to redirect to their sources
This is ready for a final review. I polished up a few minor things. The major changes are with these two sections. For both sections:
|
Last chance to review this PR. I'll merge this weekend, if there are no objections or suggestions for improvement. |
Issue number
Description
This is the first draft of the UI. Any suggestions are welcome.
Add screenshots or links to a preview of the changes
📚 Documentation preview 📚: https://plone6--1875.org.readthedocs.build/