satisfactorymodding / satisfactorymodding/FICSIT-Fred
docssearch: always search primary modding docs, or offer a way to select
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Related to https://github.com/satisfactorymodding/Documentation/issues/238
it needs to be pointed to just Latest (or offer some way of selecting which sub-site to search)
here is where it's implemented: https://github.com/satisfactorymodding/FICSIT-Fred/blob/4e83efa6849ea85cf6ea7345a8e11f3b4b08ddec/fred/fred_commands/__init__.py#L144
here is how docs does it:
https://github.com/satisfactorymodding/Documentation/blob/Dev/supplemental-ui/partials/footer-content.hbs#L5
basically you need to pass the searchParamters argument of component_name (not sure what it would be offhand) and component_version (I think always latest)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at fred/fred_commands/init.py around line 144 and compare the DocSearch setup with supplemental-ui/partials/footer-content.hbs in the Documentation repository. Check the DocSearch searchParameters API, including component_name and component_version. Done means searches target the primary Latest documentation or provide a way to select the sub-site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100