Skip to content

Chatbots info for teachers and students#33

Open
neagualexa wants to merge 6 commits intomainfrom
chatbots_info
Open

Chatbots info for teachers and students#33
neagualexa wants to merge 6 commits intomainfrom
chatbots_info

Conversation

@neagualexa
Copy link
Copy Markdown
Collaborator

I have added a new info page for teachers and students separately to present the chatbots, their purpose and a few details on how they work and differ. This information is user facing, not for developers or reseearchers.

Copy link
Copy Markdown
Member

@peterbjohnson peterbjohnson left a comment

Choose a reason for hiding this comment

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

Overall good content.

There is some repetition between files that can cause confusion to users and creates more maintenance work. You can use a hierachy: devs are teachers, teachers are students. So if the student page says 'what is a chatbot', and 'which chatbots are available', then the teacher and dev pages can just have links to those pages rather than having similar text. The repetition needs removing, which will make the docs more concise and easier to maintain.

As an example, a lot of the MEQ information is on the student page (data availability table), and therefore the teacher page just links to that page rather than duplicating.

Additionally, check the content for basics e.g. formailities ('you are' not 'you're'; not need for 'please'), capitalisation (GitHub, CLI).

You changed a button in the getting_started.md file for students. It doesn't render in the GH preview so check it renders in MK docs (I didn't check).

@neagualexa
Copy link
Copy Markdown
Collaborator Author

Overall good content.

There is some repetition between files that can cause confusion to users and creates more maintenance work. You can use a hierachy: devs are teachers, teachers are students. So if the student page says 'what is a chatbot', and 'which chatbots are available', then the teacher and dev pages can just have links to those pages rather than having similar text. The repetition needs removing, which will make the docs more concise and easier to maintain.

As an example, a lot of the MEQ information is on the student page (data availability table), and therefore the teacher page just links to that page rather than duplicating.

Additionally, check the content for basics e.g. formailities ('you are' not 'you're'; not need for 'please'), capitalisation (GitHub, CLI).

You changed a button in the getting_started.md file for students. It doesn't render in the GH preview so check it renders in MK docs (I didn't check).

Thank you for the comments, I have now restructured the pages to minimise repetition and prepare the docs to be adopted to the auto loading of the chat functions docs.

Yes, the button in getting_started.md does get rendered.

@neagualexa neagualexa requested a review from peterbjohnson May 1, 2026 15:54
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.

2 participants