You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With the establishment of tutorials.ignite.com by the EcoDev team, the primary documentation site for Ignite (docs.ignite.com) is proposed to function as a CLI-specific reference hub. This site will provide always-up-to-date CLI reference, including a breakdown of CLI commands, modules, and various capabilities.
In contrast, the tutorials site is designed to offer practical, end-to-end guidance on using the CLI and other Ignite products. This includes steps for building and scaffolding chains, use case-specific instructions, and clear entry and exit points tailored to the user journey.
As a result, tutorial and guide-based content that aligns with the purpose of the tutorials site should be removed from the primary docs site and redirected to tutorials.ignite.com. Relevant tutorials that have not yet been migrated should be transferred.
Versioning and Doc Generation:
Determine if previous versions can remain in the docs or be archived.
The removed tutorials in the docs should be captured in the next minor release. The docs will continue to be version-specific.
Tutorials have generally required manual upgrading, such as updating examples within the existing tutorials. For some time, these updates have been left behind. We can consider automation and version testing.
Acceptance Criteria:
Content removal:
Remove the following tutorials. Then migrate or replace on tutorials.ignite.com, where appropriate
Add redirect configuration in the Docusaurus config to redirect to tutorials.ignite.com. For redirects without a direct reference, generally redirect to tutorials.ignite.com.
Create a page to highlight the new tutorials site and provide a direct link.
Notes:
After content removal, various documents should be improved and repurposed. The docs site will also be refactored to reflect its CLI-specific nature.
There may also be a unified experience between docs.ignite.com and tutorials.ignite.com to better meet the needs of users and builders.
The text was updated successfully, but these errors were encountered:
Context:
With the establishment of tutorials.ignite.com by the EcoDev team, the primary documentation site for Ignite (docs.ignite.com) is proposed to function as a CLI-specific reference hub. This site will provide always-up-to-date CLI reference, including a breakdown of CLI commands, modules, and various capabilities.
In contrast, the tutorials site is designed to offer practical, end-to-end guidance on using the CLI and other Ignite products. This includes steps for building and scaffolding chains, use case-specific instructions, and clear entry and exit points tailored to the user journey.
As a result, tutorial and guide-based content that aligns with the purpose of the tutorials site should be removed from the primary docs site and redirected to tutorials.ignite.com. Relevant tutorials that have not yet been migrated should be transferred.
Versioning and Doc Generation:
Determine if previous versions can remain in the docs or be archived.
The removed tutorials in the docs should be captured in the next minor release. The docs will continue to be version-specific.
Tutorials have generally required manual upgrading, such as updating examples within the existing tutorials. For some time, these updates have been left behind. We can consider automation and version testing.
Acceptance Criteria:
Content removal:
Remove the following tutorials. Then migrate or replace on tutorials.ignite.com, where appropriate
Chores:
Notes:
After content removal, various documents should be improved and repurposed. The docs site will also be refactored to reflect its CLI-specific nature.
There may also be a unified experience between docs.ignite.com and tutorials.ignite.com to better meet the needs of users and builders.
The text was updated successfully, but these errors were encountered: