The LSX Tour Operators Plugin provides 3 post types (Accommodations, Destinations and Tours) that are the core of any Tour Operator. Use them to build day-by-day itineraries for tours.
We need to create a README.md for the design system to provide clear documentation and usage guidelines. Additionally, a banner file needs to be created that might be used in the plugin's README.md. Let's discuss where these files should be placed and how the banner can be incorporated into the plugin documentation.
Tasks:
Write a README.md for the design system.
Include an introduction, usage instructions, and any dependencies.
Design a banner image that aligns with the design system's branding.
Determine the best location for the README.md and banner file in the repository.
Confirm if and how the banner should be integrated into the plugin's README.md.
Considerations:
The README.md should be placed in the root of the design system directory or wherever the design system's main files are stored.
The banner file might need to be placed in an assets folder, which is commonly used for storing images for the plugin README.md.
References:
Examples of how banners are used in other plugins' README.md files for guidance.
Description:
We need to create a
README.mdfor the design system to provide clear documentation and usage guidelines. Additionally, a banner file needs to be created that might be used in the plugin'sREADME.md. Let's discuss where these files should be placed and how the banner can be incorporated into the plugin documentation.Tasks:
README.mdfor the design system.README.mdand banner file in the repository.README.md.Considerations:
README.mdshould be placed in the root of the design system directory or wherever the design system's main files are stored.assetsfolder, which is commonly used for storing images for the pluginREADME.md.References:
README.mdfiles for guidance.