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

Two route docs. rendering issues in "Parameters" section #14875

Closed
1 task done
cubroe opened this issue Mar 20, 2024 · 2 comments
Closed
1 task done

Two route docs. rendering issues in "Parameters" section #14875

cubroe opened this issue Mar 20, 2024 · 2 comments
Labels
docs RSS bug Something isn't working

Comments

@cubroe
Copy link
Contributor

cubroe commented Mar 20, 2024

Routes

/freecomputerbooks/:category?

Full routes

/freecomputerbooks/

Related documentation

https://docs.rsshub.app/routes/reading#free-computer-books

What is expected?

The Parameters section should render the parameter description as—

category, optional - A category id., which should be the HTML file name (but without the .html suffix) in the URL path of a book list page.

What is actually happening?

But it does this way—

category, required - A category id., which should be the HTML file name (but <strong>without</strong> the <code>.html</code> suffix) in the URL path of a book list page.

Notice that—

  1. The parameter's optionality fails to be identified/respected.
  2. The Markdown elements do get converted into HTML tags but the latter get further escaped from HTML rendering.

Deployment information

RSSHub demo (https://rsshub.app)

Deployment information (for self-hosted)

No response

Additional info

The issue is not exclusive to the mentioned route. I've simply searched the word "required" to find no relevant issues so far. This seems to be a new behavior change during the current rework of the whole codebase underway, as I remember the v2 routes' docs. used to be rendered normal.

This is not a duplicated issue

  • I have searched existing issues to ensure this bug has not already been reported
@cubroe cubroe added the RSS bug Something isn't working label Mar 20, 2024
@TonyRL TonyRL added the docs label Mar 21, 2024
@TonyRL
Copy link
Collaborator

TonyRL commented Apr 6, 2024

Fixed in RSSNext/rsshub-docs#11

@TonyRL TonyRL closed this as completed Apr 6, 2024
@cubroe
Copy link
Contributor Author

cubroe commented Apr 7, 2024

@TonyRL The optionality recognition seems still broken, e.g., for https://docs.rsshub.app/routes/reading#free-computer-books

Expected Actual
category, optional - ... category, required -

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs RSS bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants