Migrate docs from Coursemology Help repo #1

adi-herwana-nus · 2025-02-24T03:00:34Z

Migrate Markdown docs from Coursemology Help repository.
Added example translations for zh locale (incomplete).

…ions

purfectliterature

Can we upgrade to Docusaurus 3.7? The version 2.4.1 we're using was released back in March 2023 and it's too outdated.
Please set up the GitHub Actions action to automatically deploy the site. I'll defer to your judgement whether to have the action run every time a commit or tag is made. Check this official action out, but if it doesn't work, the one I used before is this, but it's unofficial. I prefer sticking to official things if possible. Let me know how it turned out!

purfectliterature · 2025-02-24T06:15:06Z

docs/instructors/1-setup/B-account-settings/index.mdx

+sidebar_label: 1b. Account Settings
+---
+
+<span style={{ color: 'red' }}><b>NOTE:</b> New sign-ups are  set to students by default.</span>


For notes, please use admonitions. Check for the rest of the documentation site for notes or additional tips and mark them up accordingly.

purfectliterature · 2025-02-24T06:16:31Z

docs/instructors/1-setup/B-account-settings/index.mdx

+
+![1B-2](/img/instructors/1B-2.gif)
+
+Note that as a student, you cannot create a course! 


Use admonitions for notes or additional tips, and drop the "Note that" or similar sounding phrases for brevity. There's no need to parenthesise sentences if they are already part of an additional information.

purfectliterature · 2025-02-24T06:20:06Z

docs/instructors/3-course/B-add-manage-users/index.md

+
+You may perform the following actions on **Manage Users** page.
+
+[[Invite Users Individually]](#invite-users-individually) [[Invite Users From File]](#invite-users-using-excel-file) [[Upgrade User Roles]](#upgrade-user-roles)


There's no need to separately create links and <a> tags for navigation like this. Just use the # headings and follow Docusarus' heading IDs.

There's also no need for this "table of contents" if you correctly use the # headings. Docusaurus will generate the correct table of content on the right sidebar of the page.

If you really want to have the table of content on the page itself, use TOCInline.

Done (removed the tags and let Docusaurus heading ids handle)

purfectliterature · 2025-02-24T06:22:29Z

docs/instructors/1-setup/A-create-account/index.md

+---
+sidebar_position: 1
+slug: /instructor-guide/setup/create-account
+title: 1a. Creating your Coursemology account


I personally don't see the point of numbering the sections hardly like this. It's so easy to keep them out of sync and cripples once you hit more than 26 sections for alphabets.

If it was up to me, I'd remove these things and just have the titles. Docusaurus will automatically generate the right tree structure for everything anyway.

I think it's fine as is for now, the numbered titles is convenient for keeping track of their progress if they choose to go through the whole thing.

purfectliterature · 2025-02-24T06:23:02Z

docs/students/index.md

+title: Student Guide
+---
+
+Here you can find the essentials of how to use Coursemology!


If there's nothing for students then we should just remove it to reduce confusion.

We are planning to add student-focused documentation in the near future, and we will certainly do so before the new guides are published on gh pages.

purfectliterature · 2025-02-24T06:26:25Z

docs/instructors/index.md

+title: Instructor Guide
+---
+
+Here you can find the essentials of how to use Coursemology!


This isn't very helpful, especially on mobile when the left sidebar that shows the entire guide tree isn't visible by default. See if there's anything that can be done with TOCInline, or just tell the user to click on the hamburger icon or navigate to the left sidebar.

There was a table on the original docs: I've readded it (as a Markdown table for now, so it renders as an actual table)

purfectliterature · 2025-02-24T06:28:21Z

docusaurus.config.js

@@ -93,6 +79,10 @@ const config = {
            label: "GitHub",


I think we can remove this. Our repository is irrelevant to the instructors.

For now, I removed it. In future, we may want to consider directing users (instructors and students) to our Github repo to report issues.

purfectliterature · 2025-02-24T06:29:16Z

docs/instructors/6-codaveri/A-feedback/index.md

+sidebar_label: 6a. Automated Feedback
+---
+
+You may use Codaveri for automated grading feedback for coding questions.


We need to first explain to them what Codaveri is. We can do it here in an admonition, or a separate index page for the Codaveri section.

purfectliterature · 2025-02-24T06:30:11Z

docs/instructors/6-codaveri/A-feedback/index.md

+
+You may use Codaveri for automated grading feedback for coding questions.
+
+First, you will need to enable **Codaveri Evaluation and Feedback** under **Course Settings**.


This should say "in Course Settings > Components". They wouldn't know where it is otherwise.

Probably a good idea to have a page on Components, then can say if they can't find certain features anywhere, they can check the Components page to see if said component is enabled. Then at least they know that Coursemology features are componentised, and if they don't like certain features, they can choose to disable it. Some instructors will ask us how to disable Forums or some gamification features because they find them intrusive or unnecessary for their course.

purfectliterature · 2025-02-24T06:33:38Z

README.md

+
+Translation keys for text in React components (marked by <Translate/> elements) can be generated by the command
+```
+$ yarn write-translations --locale zh


Add these commands to scripts in package.json instead.

…ns script

adi-herwana-nus · 2025-02-25T04:07:44Z

Can we upgrade to Docusaurus 3.7? The version 2.4.1 we're using was released back in March 2023 and it's too outdated.

Please set up the GitHub Actions action to automatically deploy the site. I'll defer to your judgement whether to have the action run every time a commit or tag is made. Check this official action out, but if it doesn't work, the one I used before is this, but it's unofficial. I prefer sticking to official things if possible. Let me know how it turned out!

Upgraded to Docusaurus 3.7 (and all other package.json dependencies)

Remaining todos:

properly introduce Codaveri in its section
explain componentization within courses (can be enabled/disabled to toggle certain features)
add student-focused documentation (can probably reuse most of the account creation/registration stuff from instructor guide)
finish translations
create github pages publishing action

adi-herwana-nus added 5 commits February 17, 2025 11:57

docs: added images from main help pages

8c79019

docs: removed placeholder docusaurus docs

128e47f

docs: migrate existing doc structure

0313f32

docs: refactor index page, config update

5309ed7

docs: move docs with html styling to .mdx; initial commit ZH translat…

11b2031

…ions

purfectliterature requested changes Feb 24, 2025

View reviewed changes

adi-herwana-nus added 4 commits February 25, 2025 11:51

docs: removed placeholder docusaurus docs

9cc387a

docs: tweaked various pages to use Docusaurus native features

d7c4830

docs: initial commit ZH translations

d88a420

chore: upgrade package.json dependencies; integrated write-translatio…

471d22f

…ns script

docs: reintegrated table of contents to index page

61ec2d8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate docs from Coursemology Help repo #1

Migrate docs from Coursemology Help repo #1

adi-herwana-nus commented Feb 24, 2025

purfectliterature left a comment

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

purfectliterature Feb 24, 2025

purfectliterature Feb 24, 2025

purfectliterature Feb 24, 2025

adi-herwana-nus Feb 25, 2025

adi-herwana-nus commented Feb 25, 2025 •

edited

Loading


		![1B-2](/img/instructors/1B-2.gif)

		Note that as a student, you cannot create a course!


		You may perform the following actions on Manage Users page.

		[[Invite Users Individually]](#invite-users-individually) [[Invite Users From File]](#invite-users-using-excel-file) [[Upgrade User Roles]](#upgrade-user-roles)


		You may use Codaveri for automated grading feedback for coding questions.

		First, you will need to enable Codaveri Evaluation and Feedback under Course Settings.

Migrate docs from Coursemology Help repo #1

Are you sure you want to change the base?

Migrate docs from Coursemology Help repo #1

Conversation

adi-herwana-nus commented Feb 24, 2025

purfectliterature left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adi-herwana-nus commented Feb 25, 2025 • edited Loading

adi-herwana-nus commented Feb 25, 2025 •

edited

Loading