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

Improve the raiseIntent documentation #461

Merged

Conversation

kriswest
Copy link
Contributor

Resolves #426

Changes:

  • add missing information and examples to the docs entry for raiseIntent and TS docs for same
  • add missing information and examples to the docs entry for raiseIntentForCOntext and TS docs for same
  • move resolvers section in spec to co-locate with raiseIntent
  • remove comments about versioning intents from spec as no functionality for doing so is defined

- add missing information and examples to the docs entry for raiseIntent and TS docs for same

- add missing information and examples to the docs entry for raiseIntentForCOntext and TS docs for same

- move resolvers section in spec to co-locate with raiseIntent

- remove comments about versioning intents from spec as no functionality for doing so is defined
@kriswest kriswest added this to the 2.0 milestone Sep 22, 2021
@kriswest kriswest added api FDC3 API Working Group docs Documentation labels Sep 22, 2021
@kriswest kriswest mentioned this pull request Sep 22, 2021
14 tasks
Copy link
Contributor

@mattjamieson mattjamieson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

docs/api/ref/DesktopAgent.md Outdated Show resolved Hide resolved
a resolver UI *should* be shown if multiple apps match the intent and context
docs/api/ref/DesktopAgent.md Outdated Show resolved Hide resolved
docs/api/ref/DesktopAgent.md Outdated Show resolved Hide resolved
docs/api/ref/DesktopAgent.md Outdated Show resolved Hide resolved
docs/api/ref/DesktopAgent.md Outdated Show resolved Hide resolved
docs/api/spec.md Outdated Show resolved Hide resolved
src/api/DesktopAgent.ts Outdated Show resolved Hide resolved
@kriswest
Copy link
Contributor Author

kriswest commented Oct 7, 2021

@rikoe Let me know if the suggested changes deal with your concerns on Resolver UIs

@kriswest kriswest requested a review from rikoe October 8, 2021 10:29
@kriswest kriswest merged commit 5612380 into finos:master Oct 8, 2021
@kriswest kriswest deleted the 426-improve-raiseIntent-documentation branch October 8, 2021 11:30
@kriswest kriswest mentioned this pull request Oct 22, 2021
11 tasks
@kriswest kriswest added the channels feeds & transactions Channels, Feeds & Transactions Discussion Group label Dec 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api FDC3 API Working Group channels feeds & transactions Channels, Feeds & Transactions Discussion Group cla-present docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for raise intent only describes the case with a specified app
3 participants