Our Project Roadmap
Help us build this Open Artifact.
Below is our vision for the future and the tasks we need help with.
The Foundation
In ProgressWe need to establish the core infrastructure. The goal is to make it easy for anyone to clone the starter and get running in under 5 minutes.
Work Needed:
- Add Netlify documentation.
- Complete the GitHub repository README.
- Set up GitHub Actions for automated builds and deployments.
- Complete the Using the Starter instructions page.
- Add documentation about generating favicons and site icons.
- Add better documentation about available shortcodes and macros.
- Add a site.xml file for SEO. This is pretty simple using 11ty collections.
The Mobile-First Experience
In ProgressThe next step is to ensure the site is fully responsive and works well on mobile devices. This includes optimizing layouts, navigation, and performance.
Work Needed:
- Optimize images and assets for faster load times on mobile networks.
- Test across various devices and screen sizes.
Nice-to-haves and Enhancements
PlannedAs I've built the starter, I've thought of new features that would enhance the user experience. These are not critical for launch but would be great to have.
Work Needed:
- Add a 'copy code' button to code blocks.
- Build a script that will auto-generate a theme file based on user colors.
- Install the markdown-it-anchor plugin to automatically add anchor links to headings in the content.
Using Obsidian as a CMS
PlannedMany users will want to use Obsidian to manage their artifact content. We need to ensure compatibility and provide clear instructions.
Work Needed:
- Document the process of setting up Obsidian with the starter.
- Explain how Obsidian can work with Sync to manage content across devices.
- Figure out a workflow for images and other assets when using Obsidian.