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

[CON-245] Add docs through config.json #1442

Closed
2 tasks done
sestinj opened this issue Jun 7, 2024 · 2 comments
Closed
2 tasks done

[CON-245] Add docs through config.json #1442

sestinj opened this issue Jun 7, 2024 · 2 comments
Assignees
Labels
area:configuration Relates to configuration options area:docs Relates to documentation kind:enhancement Indicates a new feature request, imrovement, or extension

Comments

@sestinj
Copy link
Contributor

sestinj commented Jun 7, 2024

Validations

  • I believe this is a way to improve. I'll try to join the Continue Discord for questions
  • I'm not able to find an open issue that requests the same enhancement

Problem

Can't currently specify docs sites to index through config.json

Solution

Ideally, users can write this in their config.json:

"contextProviders": [{
  "name": "docs",
  "params": { "sites": [
    {
      "title": "Jinja",
      "startUrl": "https://jinja.palletsprojects.com/en/3.1.x/",
      "rootUrl": "https://jinja.palletsprojects.com/en/3.1.x/",
    },
    {
      "title": "React",
      "startUrl": "https://react.dev/reference/",
      "rootUrl": "https://react.dev/reference/",
    }
  ]}
}]

CON-245

@sestinj sestinj changed the title Add docs through config.json [CON-245] Add docs through config.json Jun 7, 2024
@glebtumen
Copy link

I believe now you can add custom docs. Tested it on aiogram lib, asking on how to write a middleware
image
image
also it gave me example code at the end

@dosubot dosubot bot added area:configuration Relates to configuration options area:docs Relates to documentation kind:enhancement Indicates a new feature request, imrovement, or extension and removed enhancement labels Jul 8, 2024
@sestinj sestinj closed this as completed Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:configuration Relates to configuration options area:docs Relates to documentation kind:enhancement Indicates a new feature request, imrovement, or extension
Projects
None yet
Development

No branches or pull requests

3 participants