Skip to content

Adding to and reworking README.md, INSTALL.md, and INSTALL_CANVAS.md#1143

Open
dmols wants to merge 9 commits intoucfopen:devfrom
dmols:readme-additions
Open

Adding to and reworking README.md, INSTALL.md, and INSTALL_CANVAS.md#1143
dmols wants to merge 9 commits intoucfopen:devfrom
dmols:readme-additions

Conversation

@dmols
Copy link
Copy Markdown
Contributor

@dmols dmols commented Mar 27, 2026

Made changes to the installation instructions as well as the general README, so that it's a little easier to follow along.

Biggest change is that the scopes are ordered by how they appear on Canvas. That should facilitate setting up the scopes, which tends to be one of the most annoying parts of the API Key setup.

@dmols dmols requested a review from mbusch3 March 27, 2026 22:29
@dmols dmols self-assigned this Mar 27, 2026
@dmols dmols changed the title Readme Additions to README.md, INSTALL.md, and INSTALL_CANVAS.md Adding to and reworking README.md, INSTALL.md, and INSTALL_CANVAS.md Mar 27, 2026
@dmols
Copy link
Copy Markdown
Contributor Author

dmols commented Mar 27, 2026

My biggest concern here is the images I added. I made them a set size so they wouldn't appear too big on the screen, but I believe this could be inaccessible for other screen sizes. If there's a better way to handle this, I'm open to feedback!

@dmols dmols requested review from Ishfaq-code and panbed March 31, 2026 16:41
Copy link
Copy Markdown
Contributor

@Ishfaq-code Ishfaq-code left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@panbed panbed left a comment

Choose a reason for hiding this comment

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

I think it looks good, the wording sounds a lot better for the changes you made and seems friendlier to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants