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

docs: add instruction to replace perseus_integration #197

Merged

Conversation

Arrekin
Copy link
Contributor

@Arrekin Arrekin commented Sep 30, 2022

I didn't want to edit your in-depth explanation from the foldable pane, and without that, it would be kind of duplication, so instead, I opted to add a comment to the main.rs example. That way, if someone just copies the code, he'll have information right there, without the need to dig through the page.

I saw other integrations, so I added them, but maybe you don't want them exposed - let me know if you want some tweaking on this.

@Arrekin Arrekin changed the title docks: add instruction to replace perseus_integration docs: add instruction to replace perseus_integration Sep 30, 2022
Copy link
Member

@arctic-hen7 arctic-hen7 left a comment

Choose a reason for hiding this comment

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

Sorry for the late reply, I've been really busy lately! This looks great, just one minor wording thing I'd change, as I've noted.


/// Replace `<perseus_integration>` with an integration of your choice.
/// Examples of supported integrations:
/// - perseus_warp (use this one if you follow basic tutorials)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// - perseus_warp (use this one if you follow basic tutorials)
/// - perseus_warp (recommended)

@Arrekin
Copy link
Contributor Author

Arrekin commented Oct 6, 2022

Requested change applied.
E: I didn't realize I could just approve your suggestion from here :d

Copy link
Member

@arctic-hen7 arctic-hen7 left a comment

Choose a reason for hiding this comment

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

Sorry for the delay, I completely forgot to actually merge this lol!

@arctic-hen7 arctic-hen7 merged commit 8612c9e into framesurge:main Oct 17, 2022
@Arrekin Arrekin deleted the docs/clarify-integrations-in-main branch October 22, 2022 14:28
@arctic-hen7
Copy link
Member

@Arrekin just so you're aware, I've had to undo your code in fixing #212 by aliasing all instances of perseus-integration to perseus-warp, which should hopefully render this a non-issue in future!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants