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 README with project maintenance status #304

Merged
merged 7 commits into from
Jul 20, 2021

Conversation

DougInAMug
Copy link
Member

@DougInAMug DougInAMug commented Jul 9, 2021

Update README.md to reflect the changes to the project status, and link the matrix Room

@shinenelson
Copy link
Member

shinenelson commented Jul 9, 2021

3 suggestions :

  1. We can add a matrix badge to the set of other badges on the readme which would make the link to the room in a more prominent place.
  2. Rather than adding numbered links to the end of a line, can we probably link the words become deprecated ( individually )? Or alternatively, make them footnotes 1 2 ( which ironically is [not supported] by GitHub-flavored Markdown ( GFM ) which renders markdown in places like this comment; but I think it works in rendering readmes because it uses a different markdown renderer which [does support footnotes] ).
  3. We already have a badge to the jsDelivr metric. Does it make the CDN hits sentence kind of redundant? 🤔

Footnotes

  1. https://www.markdownguide.org/extended-syntax#footnotes

  2. https://kramdown.gettalong.org/syntax.html#footnotes
    [not supported]: https://github.com/github/markup/issues/498
    [does support footnotes]: https://github.com/github/cmark-gfm/pull/64

@DougInAMug
Copy link
Member Author

I like all those suggestions @shinenelson - I would wait for the badge decision (pending on history decision) before merging :)

@shinenelson
Copy link
Member

Would it make sense to use a heading like Project Status or Project Maintenance Status Update or something along those lines? Timestamps can quickly get outdated.

Also, it would nice to link to #235 and #292 to indicate where we started.

@DougInAMug
Copy link
Member Author

Thanks for suggestions again @shinenelson. I mentioned the issues you linked, and rewrote the introduction to avoid timestamp, and included matrix badge :)

Copy link
Member

@shinenelson shinenelson left a comment

Choose a reason for hiding this comment

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

Nice revamp of the introductory section. I suggested a few more changes that could make the changes even better.

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 Show resolved Hide resolved
DougInAMug and others added 4 commits July 17, 2021 17:52
Co-authored-by: shine <4771718+shinenelson@users.noreply.github.com>
- expand PRs => pull requests in first paragraph
- move the revival sentence to the previous paragraph since it is also part of the history
- add line-break after 🌱
@shinenelson shinenelson changed the title brief summary of project changes + link to matrix room Update README with project maintenance status Jul 20, 2021
@shinenelson shinenelson merged commit d8e9392 into master Jul 20, 2021
@shinenelson shinenelson deleted the DougInAMug-readmeProjectUpdate branch July 20, 2021 16:11
shinenelson added a commit that referenced this pull request Jul 20, 2021
from bad [review suggestion](#304 (comment))
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.

Community chat?
2 participants