Docs: "HOMEPAGE_COURSE_MAX" lacks documentation

[MuPp3t33r]

Hi everyone,

I see this feature/config option HOMEPAGE_COURSE_MAX has existed in the base code for a very long time, however it seems to lack documentation.

I suppose it might be best fitting for this to be added in settings.html ?

Here is reference to a community post in which a user was looking for documentation related to this config: https://discuss.openedx.org/t/front-page-limit-number-of-displayed-courses/17450

Thank you

[sarina]

@brian-smith-tcril are we still using/respecting this setting in the new MFE?

[sarina]

@MuPp3t33r we would totally accept a PR for this! https://docs.openedx.org/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html

[brian-smith-tcril]

Yes. HOMEPAGE_COURSE_MAX is in the API spreadsheet we made for FC-86 as

Functionality	Do we want this functionality?	Legacy Implementation	Proposed MFE Implementation	Reviewed & Approved by Axim?	Notes
Maximum number of courses to display on the index/homepage.	Yes (needs DEPR)	homepage_course_max - in Site Configuration or Django settings	expose as MFE_CONFIG fallback. see #37130	Yes	We should expose the legacy site configuration values as fallbacks for new MFE_CONFIG values

And it's being used here

const maxCourses = getConfig().HOMEPAGE_COURSE_MAX || DEFAULT_COURSES_COUNT;

[Ozohu1]

Thanks for the clarification shared above — this has made it clear that HOMEPAGE_COURSE_MAX is still in use and represented in the FC-86 API spreadsheet.

I’d be happy to take this on and prepare a PR to document the setting. Before I begin, could I confirm the preferred location for this documentation?

Should it be added under settings.html, or documented following the feature toggle guidance here?
https://docs.openedx.org/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html

Once confirmed, I’ll proceed accordingly.

Thanks!

[feanil]

You should document it using https://docs.openedx.org/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html

settings.html is generated based on the annotations in the code.

[Ozohu1]

Thanks for the clarification - I’ll follow the feature toggle documentation approach and proceed accordingly.