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.

Sign up for GitHub

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

Jump to bottom

docs: update readme to be pure markdown #199

Merged
merged 4 commits into from
Jan 23, 2024
Merged

docs: update readme to be pure markdown #199

merged 4 commits into from
Jan 23, 2024

Conversation

beeme1mr
Copy link
Member

@beeme1mr beeme1mr commented Jan 23, 2024 •
edited by austindrenski
Loading

This PR

  • update readme to be pure markdown without HTML

Notes

https://cloud-native.slack.com/archives/C06EDTWU25B/p1706000859339279

Follow-up Tasks

  • Update org template
  • Update doc scripts
  • Update other SDK readmes

Related

@beeme1mr
update readme to be pure markdown
0dd0b60 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@beeme1mr beeme1mr requested a review from a team as a code owner January 23, 2024 15:06
austindrenski
austindrenski requested changes Jan 23, 2024
View reviewed changes
Copy link
Member

@austindrenski austindrenski left a comment

Choose a reason for hiding this comment

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

Looks great on GitHub, so just a few comments to make the badges clickable again:

image

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@beeme1mr @austindrenski
Apply suggestions from code review
991796c 
Co-authored-by: Austin Drenski <austin@austindrenski.io>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
austindrenski
austindrenski approved these changes Jan 23, 2024
View reviewed changes
Copy link
Member

@austindrenski austindrenski left a comment

Choose a reason for hiding this comment

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

Verified the clickables, thanks for doing this!

@beeme1mr
readded the release please tag
c1668ff 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@beeme1mr
remove dark mode support from readme
91f2983 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
@beeme1mr beeme1mr merged commit 33db9d9 into main Jan 23, 2024
5 checks passed
@github-actions github-actions bot mentioned this pull request Jan 23, 2024
Merged
@askpt askpt linked an issue Jan 23, 2024 that may be closed by this pull request
[DOC] add readme to published package #138
Closed
arttonoyan pushed a commit to arttonoyan/dotnet-sdk that referenced this pull request Nov 17, 2024
@beeme1mr @austindrenski @arttonoyan
docs: update readme to be pure markdown (open-feature#199)
5b04d6f 
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Austin Drenski <austin@austindrenski.io>
Signed-off-by: Artyom Tonoyan <artonoyan@servicetitan.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@toddbaert toddbaert toddbaert approved these changes

@austindrenski austindrenski austindrenski approved these changes

Assignees

@beeme1mr beeme1mr

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] add readme to published package
3 participants
@beeme1mr @austindrenski @toddbaert