Document endpoint required by Copilot
Open
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
Should be added to https://vaadin.com/docs/latest/tools/copilot (maybe a subsection):
- Mention Copilot loads external resources that are not bundled with the framework, as this will cause errors for users with custom CSP headers or tighter firewall configs.
- Explicitly document all required endpoints so they can be included/whitelisted as needed.
- Ideally, include a brief description of the "purpose" of each endpoint.
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 by reading the Copilot documentation at https://vaadin.com/docs/latest/tools/copilot and identify how external resources are loaded. Done means adding a subsection that lists every required endpoint, explains each endpoint's purpose, and notes CSP and firewall allowlisting considerations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100