generated from alshedivat/al-folio
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Description
The current README.md file lacks detailed information about each page of the website and the solution chosen to automate the creation of collection and book markdown files. Updating the README.md with this information will help others to understand the project structure, the purpose of each page, and the automation process.
Technical Information
- Context: The README.md file serves as the primary documentation for the project, providing essential information to developers and contributors.
- Background: The project includes multiple pages with specific functions, and a script has been developed to automate the creation of markdown files for collections and books.
- Suggested Approach:
- Add a section to the README.md detailing each page of the website, including its purpose and any relevant technical details.
- Document the automation script used to generate collection and book markdown files, including setup, usage instructions, and any dependencies.
Acceptance Criteria
- The README.md file includes a new section detailing each page of the website.
- Each page's description includes its purpose and any relevant technical details.
- The README.md file includes a new section describing the automation script for generating markdown files.
- The automation script documentation includes setup instructions, usage guidelines, and dependency information.
Metadata
Metadata
Assignees
Labels
featureNew featureNew feature
Type
Projects
Status
ReadyForDevelopment