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

Add a new section Inspiration Projects #3517

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a new section Inspiration Projects #3517

wants to merge 1 commit into from

Conversation

psss
Copy link
Collaborator

@psss psss commented Feb 10, 2025

What about adding a new section to the Questions page where we could provide links to some interesting projects which can serve as an inspiration for users?

Pull Request Checklist

  • write the documentation

What about adding a new section to the Questions page where we
could provide links to some interesting projects which can serve
as an inspiration for users?
@psss psss added the documentation Improvements or additions to documentation label Feb 10, 2025
@martinhoyer
Copy link
Collaborator

Great idea to have implementation examples / success stories in the docs imho.
Not sure about "Questions->Inspiration". I'm thinking "Showcase" page under "Overview"? With a more comprehensive (yet succinct) list. Not sure how to format the page, maybe with chapters like "Success Stories", "Implementation Examples", ...?
"Who is using tmt" might be also a good title.

btw, I've noticed there are /Overview/Examples and /Examples pages. Shouldn't we deduplicate them?

Copy link
Collaborator

@thrix thrix left a comment

Choose a reason for hiding this comment

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

LGTM

@psss
Copy link
Collaborator Author

psss commented Feb 11, 2025

Not sure about "Questions->Inspiration". I'm thinking "Showcase" page under "Overview"?

The Overview page is currently the source of the man page. I'm not sure it would be a good fit for this.

With a more comprehensive (yet succinct) list. Not sure how to format the page, maybe with chapters like "Success Stories", "Implementation Examples", ...?

Yeah, definitely, once we put together more stuff, we can even have a dedicated page for that. For now, I'd say, a short section would be a good start.

"Who is using tmt" might be also a good title.

Actually, that title would very nicely fit the Questions section, what do you think? I was also considering adding this to the Guide, perhaps at the end? Any other ideas / opinions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants