Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Summary #52

Open
Mailaender opened this issue Oct 19, 2022 · 3 comments
Open

Documentation Summary #52

Mailaender opened this issue Oct 19, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@Mailaender
Copy link
Member

Description = "This documentation is aimed at modders. It displays all traits with default values and developer commentary."

is not really helpful. Parse https://docs.openra.net/en/bleed/search/search_index.json instead.

@Mailaender Mailaender added the enhancement New feature or request label Oct 19, 2022
@penev92
Copy link
Member

penev92 commented Jul 5, 2023

I solved this in #57 by parsing the HTML, then realized there was a json file available (which may be a better solution?) when I came here to mark this as done. 🤦

@penev92
Copy link
Member

penev92 commented Jul 7, 2023

Upon further investigation using HtmlAgilityPack to parse the HTML instead of the JSON file yields better result as I can actually target the trait/weapon/sequence/table description, while in the JSON those are mixed with all the other text content about the entity.
So for the summary I will keep to parsing the HTML.

However, it would be interesting to investigate using the JSON to provide autocomplete suggestions for trait/weapon/sequence/table names when the user is invoking the commands.

@Mailaender
Copy link
Member Author

I also noticed that the JSON search is incomplete and seems to cut off after a certain number of characters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants