plone / plone/documentation

Add "Related content" as the final section in most pages

Open
#1,973 10 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

41 lvl: easy 99 tag: good first issue 99 tag: hacktoberfest
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

As an example, the MS SQL docs have "Related content" as the final section in most of their pages.

Screenshot 2025-09-22 at 12 49 15 AM

https://learn.microsoft.com/en-us/sql/t-sql/queries/at-time-zone-transact-sql?view=sql-server-ver17#related-content

I think something like this would be a nice enhancement for the future docs structure.

[!CAUTION]
Pull requests that don't meet the following requirements shall be immediately closed.

  1. The contributor should actually read and understand the content on both the page where they put the links and the destination pages of the links.
  2. Ensure that the content between pages or sections is truly related. I've already seen and closed many PRs that mindlessly match a single word.
  3. Not be on index.md pages. There's no content on index pages, so it's impossible for anything to be related to it.
  4. Not be on pages that serve a similar function as index pages, such as a landing page that directs users to other pages.

Originally posted by @stevepiercy in https://github.com/plone/volto/pull/7360#discussion_r2367018720

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository file or test is named. Start by reviewing the documentation structure and identifying eligible non-index pages, then use the stated contribution requirements to select genuinely related destinations. Done means appropriate pages have a final Related content section with meaningful links, without changing index or landing pages.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.