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

provide useful start-page content #13

Open
1 of 9 tasks
marc-portier opened this issue May 31, 2022 · 1 comment
Open
1 of 9 tasks

provide useful start-page content #13

marc-portier opened this issue May 31, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@marc-portier
Copy link
Member

marc-portier commented May 31, 2022

the current "lorem ipsum" placeholders need to be replaced with actual content

first rough ideas are:

  • what

    • what is it, what does it do (and what not)
    • for who is it targeted (currently vs future iterations)
    • why should you use it
  • who

    • is behind this --> link to us / our teams-page at github
    • is using this + showing examples (and a mechanism for new users to get listed)
  • how

    • getting started / maybe some setup wizard?
    • linking to some site (subsection of teams page?) providing the documentation / embedded tutorials (video or slideware)
    • how to get into contact and register remarks / suggestion / usage / ... --> via github issues
    • how to contribute to the project
@cedricdcc cedricdcc assigned cedricdcc and kmexter and unassigned cedricdcc and kmexter Jun 1, 2022
@cedricdcc cedricdcc added the documentation Improvements or additions to documentation label Jun 1, 2022
@johannesnauta johannesnauta self-assigned this Aug 3, 2022
@johannesnauta
Copy link
Contributor

I think we should probably generate several versions of a diagrammatic overview of the workflow that the assistant is trying to achieve:

  • A very basic version, that gives a general overview of what the assistant will do
  • A more thorough version that includes more (but not all!) details of the 'inner workings' of the assistant

This will, in my opinion, greatly increase understanding of the scope of the project and outline what it will do and what it will not do!

@cedricdcc cedricdcc self-assigned this Jan 24, 2023
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

No branches or pull requests

4 participants