Skip to content

Update Documentation and Guides for Customer Portal#7

Closed
lyzhang0113 wants to merge 25 commits into
mainfrom
preview
Closed

Update Documentation and Guides for Customer Portal#7
lyzhang0113 wants to merge 25 commits into
mainfrom
preview

Conversation

@lyzhang0113
Copy link
Copy Markdown
Collaborator

Please Squash the commits when merging.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates and restructures the Dynamsoft Customer Portal documentation with significant improvements to content organization, formatting, and completeness.

  • Standardizes link formatting in the main documentation index with proper title case
  • Adds comprehensive new documentation page for quota usage management
  • Extensively rewrites and improves existing customer portal guides with better structure, clearer instructions, and enhanced visual presentation

Reviewed Changes

Copilot reviewed 20 out of 73 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
index.md Updates Customer Portal navigation links with consistent title case formatting and adds new quota usage link
customer-portal/quota-usage.md New comprehensive guide for checking license quota usage with step-by-step instructions
customer-portal/trial-license.md Complete rewrite with improved formatting, clearer sections, and enhanced documentation structure
customer-portal/request-upgrade.md Restructured content with better organization and clearer upgrade instructions
customer-portal/renewal.md Improved formatting and clearer step-by-step renewal processes
customer-portal/quote-purchase.md Enhanced guide with better structured payment options and clearer instructions
customer-portal/manage-contacts.md Significantly expanded with detailed explanations of contact types and management procedures
customer-portal/index.md Restructured with organized topic categories and improved navigation
customer-portal/full-license.md Enhanced with better structure and clearer license management instructions
customer-portal/faq.md Completely restructured FAQ with categorized sections and comprehensive answers
customer-portal/expand-quota.md Improved formatting and clearer step-by-step quota expansion instructions
customer-portal/email-notification.md Enhanced structure with clearer subscription and notification management
Configuration files Updates to support new documentation structure and build processes
Comments suppressed due to low confidence (1)

Comment thread customer-portal/quota-usage.md Outdated
Comment thread customer-portal/quota-usage.md Outdated

3. On the License Details page, click **Manage the License** at the top.

![Manage the License](/assets/img/customer-portal-quota-usage-2.png)
Copy link

Copilot AI Jul 16, 2025

Choose a reason for hiding this comment

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

Image path uses absolute reference '/assets/img/' instead of the site variable '{{site.assets}}img/' used consistently elsewhere in the codebase. This should be '{{site.assets}}img/customer-portal-quota-usage-2.png' for consistency.

Suggested change
![Manage the License](/assets/img/customer-portal-quota-usage-2.png)
![Manage the License]({{site.assets}}img/customer-portal-quota-usage-2.png)

Copilot uses AI. Check for mistakes.
Comment thread customer-portal/quota-usage.md Outdated

5. Click **View Statistics** for the relevant project.

![View Statistics Button](/assets/img/customer-portal-quota-usage-3.png)
Copy link

Copilot AI Jul 16, 2025

Choose a reason for hiding this comment

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

Image path uses absolute reference '/assets/img/' instead of the site variable '{{site.assets}}img/' used consistently elsewhere in the codebase. This should be '{{site.assets}}img/customer-portal-quota-usage-3.png' for consistency.

Suggested change
![View Statistics Button](/assets/img/customer-portal-quota-usage-3.png)
![View Statistics Button]({{site.assets}}img/customer-portal-quota-usage-3.png)

Copilot uses AI. Check for mistakes.
- Expiry date
- Supported modules and related information

![Quota Usage Details](/assets/img/customer-portal-quota-usage-4.png)
Copy link

Copilot AI Jul 16, 2025

Choose a reason for hiding this comment

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

Image path uses absolute reference '/assets/img/' instead of the site variable '{{site.assets}}img/' used consistently elsewhere in the codebase. This should be '{{site.assets}}img/customer-portal-quota-usage-4.png' for consistency.

Suggested change
![Quota Usage Details](/assets/img/customer-portal-quota-usage-4.png)
![Quota Usage Details]({{site.assets}}img/customer-portal-quota-usage-4.png)

Copilot uses AI. Check for mistakes.
title: Request Trial License
keywords: trail license
description: request a free trial license
keywords: trial license, free trial, Dynamsoft license
Copy link

Copilot AI Jul 16, 2025

Choose a reason for hiding this comment

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

The keyword 'trail license' in the removed line was misspelled and has been correctly changed to 'trial license' in the new content.

Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

3 participants