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: v8 docs #637

Merged
Merged

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Oct 12, 2022

🚥 Fix RM-5536

🧰 Changes

Goals

  • Encourage GHA setup through new --github flag, but provide documentation on manual setup if users need it 🧠
  • Improved clarity/conciseness/structure (i.e., simpler instructions, separate out detailed examples into separate pages) 🤌
  • Encourage global installation + login (now that our login command sucks less now) 🌏
  • (Related to the above) new drip (courtesy of @jaclynchao) 😮‍💨
  • Draw more attention to the fact that rdme can be used without a ReadMe account (i.e., for reducing/validating OAS) ✨

🧬 QA & Testing

Do the docs achieve the above goals? And are they free of any grammar/mechanical issues?

@kanadgupta kanadgupta added this to the v8 milestone Oct 12, 2022
@kanadgupta kanadgupta added the documentation Improvements or additions to documentation label Oct 12, 2022
README.md Outdated Show resolved Hide resolved
@kanadgupta kanadgupta marked this pull request as ready for review October 17, 2022 23:45
@kanadgupta kanadgupta requested review from erunion, darrenyong, rafegoldberg, RyanGWU82 and a team and removed request for a team October 17, 2022 23:45
documentation/rdme.md Outdated Show resolved Hide resolved
documentation/github-actions-docs-example.md Outdated Show resolved Hide resolved
documentation/github-actions-docs-example.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
also rearranged the installation steps so global installation is first

Co-Authored-By: Ryan Park <[email protected]>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
documentation/github-actions-docs-example.md Outdated Show resolved Hide resolved
documentation/rdme.md Show resolved Hide resolved
kanadgupta and others added 2 commits October 18, 2022 12:17
Co-Authored-By: Jon Ursenbach <[email protected]>
Co-Authored-By: Jon Ursenbach <[email protected]>
@kanadgupta kanadgupta merged commit 757981e into main Oct 31, 2022
@kanadgupta kanadgupta deleted the kanad/rm-5536-update-docs-in-github-repo-and-knowledge branch October 31, 2022 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants