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

chore: deep link documentation for registering proposals #4886

Merged

Conversation

maxwellmattryan
Copy link
Contributor

Summary

Please summarize your changes, describing what they are and why they were made.

We desperately needed documentation for our deep link design, so that it can be more easily used by any platform wishing to interact with Firefly.

Changelog

- Add deep link specification
- Add images of some UI (for new doc)

Relevant Issues

Please list any related issues using development keywords.

Closes #4872

Testing

Platforms

Please select any platforms where your changes have been tested.

  • Desktop
    • MacOS
    • Linux
    • Windows
  • Mobile
    • iOS
    • Android

Instructions

Please describe the specific instructions, configurations, and/or test cases necessary to test and verify that your changes work as intended.

  1. Checkout this branch (chore/deep-link-documentation-for-registering-events)
  2. Run yarn docs:start in the root directory of the repository

Checklist

Please tick all of the following boxes that are relevant to your changes.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or modified tests that prove my changes work as intended
  • I have verified that new and existing unit tests pass locally with my changes
  • I have verified that my latest changes pass CI workflows for testing and linting
  • I have made corresponding changes to the documentation

@maxwellmattryan maxwellmattryan added type:documentation Add or update documentation stardust Related to the Stardust Protocol labels Oct 13, 2022
@maxwellmattryan maxwellmattryan self-assigned this Oct 13, 2022
@maxwellmattryan maxwellmattryan marked this pull request as ready for review October 13, 2022 17:46
@maxwellmattryan maxwellmattryan linked an issue Oct 13, 2022 that may be closed by this pull request
4 tasks
Copy link
Contributor

@Tuditi Tuditi left a comment

Choose a reason for hiding this comment

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

Great work! 🥳

docs/specifications/deep-links.md Outdated Show resolved Hide resolved
docs/specifications/deep-links.md Outdated Show resolved Hide resolved
docs/specifications/deep-links.md Outdated Show resolved Hide resolved
docs/specifications/deep-links.md Outdated Show resolved Hide resolved
docs/specifications/deep-links.md Outdated Show resolved Hide resolved
docs/specifications/deep-links.md Show resolved Hide resolved
docs/specifications/deep-links.md Show resolved Hide resolved
docs/specifications/deep-links.md Show resolved Hide resolved
docs/specifications/deep-links.md Show resolved Hide resolved
docs/specifications/deep-links.md Show resolved Hide resolved
maxwellmattryan and others added 3 commits October 13, 2022 13:21
Co-authored-by: Tuditi <45079109+Tuditi@users.noreply.github.com>
Co-authored-by: Tuditi <45079109+Tuditi@users.noreply.github.com>
Copy link
Contributor

@Tuditi Tuditi left a comment

Choose a reason for hiding this comment

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

LGTM! 🔥

@Tuditi Tuditi merged commit fdba443 into stardust-develop Oct 13, 2022
@Tuditi Tuditi deleted the chore/deep-link-documentation-for-registering-events branch October 13, 2022 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stardust Related to the Stardust Protocol type:documentation Add or update documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Write deep link documentation for registering events
2 participants