Add automatic 'See also' recommendations to every wiki article#241
Open
Shreenabh664 wants to merge 4 commits intoRoboticsKnowledgebase:masterfrom
Open
Add automatic 'See also' recommendations to every wiki article#241Shreenabh664 wants to merge 4 commits intoRoboticsKnowledgebase:masterfrom
Shreenabh664 wants to merge 4 commits intoRoboticsKnowledgebase:masterfrom
Conversation
nevalsar
force-pushed
the
master
branch
2 times, most recently
from
4f6c490 to
ca3abce
Compare
Collaborator
|
Implementation looks good to me, but how does this feature interact with existing pages that have a statically written "See also" section? Will the article have two See alsos? |
Pre-render check in the client-side JS: scan the article body for any H2-H4 heading whose text matches "See also" (case-insensitive, optional trailing : or .) and bail out before fetching/rendering the auto recs. This addresses the duplicate-section concern raised by p-amyjiang on the PR -- about 57 wiki articles already ship a manually written See also list, and they should keep authorial curation untouched. The auto-injected `.sa-heading` is excluded from the detector so the guard stays idempotent if the script ever re-runs on the same DOM.
Author
Fixed, we retain author's curation if present & dont inject a new section now. |
Collaborator
|
LGTM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The algorithm auto-identifies the top N (≤ 4, based on confidence) most relevant articles to the current one and references them at the bottom in a "See also" section. It's a fully dynamically computed feature at build time - which means it doesn't require manual curation, new articles get matched automatically, and if a more relevant article to a specific existing topic is added in the future, it'll get auto-referenced.
This is a step to take this wiki closer to conventional wikis (like Wikipedia), which are very well cross-referenced - users can go on independent learning paths by simply following the suggested articles after reading any page.