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: Update README and SECURITY for docs migration #671

Merged
merged 7 commits into from
Dec 5, 2024

Conversation

edibotopic
Copy link
Contributor

@edibotopic edibotopic commented Dec 3, 2024

The authd docs have been migrated from the GH wiki to Read the Docs.
This PR updates links to the documentation in the README.md and SECURITY.md .
In addition, a docs badge (build pass/fail) was added to the README.md.

Other minor changes:

  • Removed capitalisation in first letter of authd for consistency of branding
  • Reduced direct links to doc pages in README (maintenance issue at this stage in the docs development)
  • Shortened line lengths in README (for source readability)

UDENG-5515

@edibotopic edibotopic marked this pull request as ready for review December 3, 2024 14:41
@edibotopic edibotopic requested a review from a team as a code owner December 3, 2024 14:41
@edibotopic edibotopic changed the title Update readme for docs migration docs: Update readme for docs migration Dec 3, 2024
@edibotopic edibotopic changed the title docs: Update readme for docs migration docs: Update README and SECURITY for docs migration Dec 3, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
- added link to docs on read the docs
- removed direct links to doc pages (maintenance issue at early stage of
docs development)
- removed capital letter from "authd"
- reduced line length in source file
@edibotopic edibotopic force-pushed the update-readme-for-docs-migration branch from 3359fe5 to d561f57 Compare December 4, 2024 09:18
@edibotopic
Copy link
Contributor Author

edibotopic commented Dec 4, 2024

I changed to ref-style links in d561f57, @3v1n0 -- thanks for the tip.

@edibotopic edibotopic requested a review from 3v1n0 December 4, 2024 12:26
README.md Outdated Show resolved Hide resolved
Co-authored-by: Marco Trevisan <[email protected]>
@3v1n0 3v1n0 merged commit 1469430 into main Dec 5, 2024
10 checks passed
@3v1n0 3v1n0 deleted the update-readme-for-docs-migration branch December 5, 2024 16:19
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