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

Complete Readme Revamp #384

Closed
wants to merge 3 commits into from
Closed

Complete Readme Revamp #384

wants to merge 3 commits into from

Conversation

AdamTmHun
Copy link

Complete Readme Revamp

  • New widgets/shields
  • New layout
  • New Content Menu
  • Clickable stuff
  • New menus
  • 🐣

Complete Readme Revamp
- New widgets/shields
- New layout
- New Content Menu
- Clickable stuff
- New menus
- 🐣
@CyanVoxel CyanVoxel added the Type: Documentation Additions/changes to documentation label Aug 24, 2024
@CyanVoxel CyanVoxel added Priority: Medium An issue that shouldn't be be saved for last Status: Review Needed A review of this is needed labels Aug 24, 2024
@CyanVoxel CyanVoxel added Priority: Low Doesn't require immediate attention and removed Priority: Medium An issue that shouldn't be be saved for last labels Aug 24, 2024
@eivl
Copy link

eivl commented Sep 6, 2024

fix conflicts and tag me for review @AdamTmHun

@CyanVoxel CyanVoxel removed the Status: Review Needed A review of this is needed label Dec 7, 2024
@xarvex
Copy link
Member

xarvex commented Mar 12, 2025

I don't think there's any interesting in having a rather cookie-cut template for the README, that while I'm sure had the goal of catching attention, actually discards. As potentially the first document a user might read, it is not something that should appear closely identical to several other projects out there in boring and stale conformity.
Also, not to be “that guy” but while there is fun and jokes to be had, there is some objectively bad taste present here that is not fit for the potential first impression I brought up.
Outside of that, we have a documentation site now, where some finer details can go that have trouble being condensed to one view: https://docs.tagstud.io/

@xarvex xarvex closed this Mar 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Low Doesn't require immediate attention Type: Documentation Additions/changes to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants