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

Update docs with minor improvements for add-on discoverability #513

Merged
merged 2 commits into from
Sep 12, 2023

Conversation

CryHavoc21
Copy link
Contributor

I wanted to make some changes to the docs to help with discoverability of some features, most notably for add-ons. I'm not an expert on markdown, so the links for now are URL links instead of links between markdown pages.

Summary of changes:

README.md: added a link to the github page (as far as I know, this is the page that generates https://gp2040-ce.info/, and there was no link back to the github repo) and a direct link to Turbo functionality under the features list. In future this could be expanded to direct link all the features to their documentation, but I'm leaving it for now so that this PR can be incremental

docs/usage.md: I pulled the paragraph from InfraredAces on discord from our discussion to replace the "unfinished docs" section on turbo and analog stick emulation, but with extra links to turbo and analog stick add-ons (to preserve the link from this page to that concept)

docs/web-configurator-add-ons.md: Reworded the "experimental" phrasing, since from discussion with InfraredAces, not all add-ons should be considered experimental. Some trailing spaces were also removed.

README.md Show resolved Hide resolved
Copy link
Contributor

@InfraredAces InfraredAces left a comment

Choose a reason for hiding this comment

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

Corrections on typos and usage of markdown links referencing sections in other documents

README.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
@InfraredAces InfraredAces merged commit 5ceafb4 into OpenStickCommunity:main Sep 12, 2023
52 checks passed
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.

None yet

2 participants