Create a "Customization Guide" Document

[Jim U]

Users who wish to customize QC need to understand the roles and responsibilities of the QC’s significant public classes, interfaces, components, data structures and objects. Provide an overview of each of them and the relationships between them.

Note: I use italics below to indicate hyperlinks to other documentation.

Start the document by describing the target audience of the document:

This document is intended for QC users who wish to customize QC functionality. It assume users have a working knowledge of the basic functions of QC and experience writing C# scripts. For an introduction to QC’s basic functions read Getting Started.

• Explain the responsibilities of each class/interface/component/object
• Describe how they are related (e.g., QuantumConsole is a wrapper for QuantumConsoleProcessor)
• Link to full documentation whenever possible instead of replicating or summarizing documentation.
• Include a section targeting popular customizations. Briefly describe how to effect it. For example:

* To change the look and feel of the QC Window such as fonts and colors, explore the QuantumConsole object’s children.

* To add a custom command to QC, see the Getting Started document.

* To remove all built-in commands in QC, add this line to the top of QuantumConsoleProcessor.cs:

#define QC_DISABLE_BUILTIN_ALL

‌

[Yusuf Ismail]

Would you say a page like this would go well in the existing “Extending QC“ section as a more architectural overview page if people want to make modifications or extensions not covered?

https://www.qfsw.co.uk/docs/QC/articles/extending/intro.html

[Jim U]

That sounds reasonable to me.

I mostly envision a kind of “homepage” for developers that helps direct them to the resources most responsible for a particular feature. Both existing features and new features.

The first step in making a “modification or extension not covered” is discovering whether or not this customization is in already implemented QC. So I would include this learning in the scope of this page.

‌

[Jim U]

https://www.qfsw.co.uk/docs/QC/articles/extending/intro.html

‌

TIP
Feel free to contact ***support*** for assistance

This should be a link to a support page.

I realize you have icons at the bottom of the page to email/twitter/discord, but these icons are ubiquitous on the Internet and 90% of them are neglected and not monitored. I don’t expect them to work and I click on them them only as a last resort, then only if I notice them at all.

[Terry Tucker]

As an educator, I have always been on the lookout for ways to enhance the learning experience of my students. That's why I was thrilled to come across this article on how customization benefits and boosts learning management systems. The author does an excellent job of explaining how customization can help educators tailor their teaching methods to the unique needs of their students. One of the most significant benefits of customization is that it allows educators to create personalized learning paths for their students. This means that students can learn at their own pace and in a way that suits their individual learning style. As someone who has seen firsthand the benefits of personalized learning, I can attest to how much of a difference it can make in a student's academic success and read more at https://techniciansnow.com/how-customization-benefits-and-boosts-learning-management-systems/. Another benefit of customization is that it allows educators to create a more engaging learning experience for their students. By incorporating multimedia elements such as videos, images, and interactive quizzes, educators can make learning more fun and interactive. This not only helps students retain information better but also makes learning more enjoyable. Overall, I found this article to be an excellent resource for educators looking to enhance their teaching methods. The author does an excellent job of explaining the benefits of customization in a way that is easy to understand and apply. I highly recommend this article to anyone looking to improve their teaching methods and create a more engaging learning experience for their students.