Skip to content

Conversation

BytePaul
Copy link

@BytePaul BytePaul commented Sep 3, 2025

This PR adds a new "Forum Browser" page under the Community section.

  1. Introduces /community-forum-browser.html with search, filter, and sort for mirrored Discourse topics
  2. Adds link to Community sidebar
  3. Includes tools/fetch_precice_forum.py to update assets/data/forum/topics.json

@BytePaul
Copy link
Author

BytePaul commented Sep 3, 2025

This is how the new addition "Forum Browser" looks like

precice_forum_page

Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

Thanks for this PR, looks very nice!
Some first comments to consider. I will do a more thorough review later.

Comment on lines 122 to 124
- title: Forum Browser
url: /community-forum-browser.html
output: web
Copy link
Member

Choose a reason for hiding this comment

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

A more fitting place would be in the docs_sidebar.yaml, under Fundamentals, between Roadmap and Previous versions.

A better title would be FAQ and initialized with the faq tag in all categories.

Copy link
Author

Choose a reason for hiding this comment

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

I have made the improvements as suggested. Let me know if it works.

Copy link
Member

Choose a reason for hiding this comment

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

This data should not be directly in the repository. It should either:

a) be always loaded on demand when the page is loading, or
b) be stored in Git LFS and updated periodically with a GitHub Action.

Option (a) would be the easier to implement, option (b) could potentially be faster. Let's start with option (a).

Copy link
Member

Choose a reason for hiding this comment

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

The check old API us pre-commit hook is also failing, because it is picking up keywords in the JSON file. Removing the JSON file from the repository (and loading it every time it is needed) would fix that.

Copy link
Member

Choose a reason for hiding this comment

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

@BytePaul this file still needs to be removed from this branch (and the system needs to fetch the data on demand).

See #576 for an example of how to implement a button to fetch the data. Rendered on https://precice.org/fundamentals-roadmap.html

Copy link
Member

Choose a reason for hiding this comment

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

This originates from #582. Please rebase on master and remove the unrelated files.

Copy link
Member

Choose a reason for hiding this comment

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

@BytePaul FYI, I will wait for the cleanup before I continue with the rest of my review.

Copy link
Member

Choose a reason for hiding this comment

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

@BytePaul the changes to this file still need to be removed from this branch.

- Relocated sidebar entry from community_sidebar.yaml to docs_sidebar.yaml
- Placed FAQ under Fundamentals, between Roadmap and Previous versions
- Renamed 'Forum Browser' to 'FAQ'
- Added faq tag to enable categorization
@BytePaul BytePaul force-pushed the feature/forum-topics-fetch branch from 47ed4af to c4ed1da Compare October 6, 2025 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants