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: Updated readme #1281

Merged
merged 3 commits into from
Jan 11, 2024
Merged

docs: Updated readme #1281

merged 3 commits into from
Jan 11, 2024

Conversation

Histalek
Copy link
Member

@Histalek Histalek commented Jan 8, 2024

Restructured and reworded some paragraphs.
Removed unneeded whitespace.
Added alt-text for the banners.
Removed HTML newlines.
Linked bugreport and featurerequest templates instead of generic issue page.

The different paragraphs can probably be rewritten even more, but i mostly just wanted to cleanup the markdown file.

Restructured and reworded some paragraphs.
Removed unneeded whitespace.
Added alt-text for the banners.
Removed HTML newlines.
Linked bugreport and featurerequest templates instead of generic issue page.
@Histalek Histalek added type/docs Improvements or additions to documentation keepalive skip-changelog Skips the requirement for an entry in the CHANGELOG.md labels Jan 8, 2024
README.md Outdated Show resolved Hide resolved
@saibotk
Copy link
Member

saibotk commented Jan 8, 2024

Can we just scrap all the feature sections?

This is the Readme on GH and i think its much better to only point towards the relevant resources and keeping it short :)

@Histalek
Copy link
Member Author

Histalek commented Jan 8, 2024

Can we just scrap all the feature sections?

This is the Readme on GH and i think its much better to only point towards the relevant resources and keeping it short :)

So everything after ## Setup (excluding) up to ## The History of TTT2?

Having those on a seperate 'Sales Pitch' webpage or something would make sense. We don't currently have a page like that, right?

@saibotk
Copy link
Member

saibotk commented Jan 11, 2024

I'd consider the Workshop page the "sales pitch". I think this is more than enough.

The sales pitch is already on the homepage of our docs and on the steam
page.
@Histalek Histalek merged commit 7d78ce4 into master Jan 11, 2024
3 checks passed
@Histalek Histalek deleted the update-readme branch January 11, 2024 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skips the requirement for an entry in the CHANGELOG.md type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants