Full documentation missing

[Jeehut]

I was just trying to get started with this project and found that the only documentation seems to live in the README file. While that's a good starting point, I still had lots of questions after fully reading it and it took me ~1 hour to fully discover all the available elements and features by scanning through the entire projects source code and checking the structure and comments in the Starter project.

Since most of the code already has some useful documentation, I think a DocC-rendered site with a couple articles to get people started would go a long way in helping people to quickly check if this project covers their needs or not. Since I'm sure you're busy with WWDC aftermath, I'm happy to help. I can do a similar setup to what I've done for of my open-source project HandySwift, see here. The documentation then would live on swiftpackageindex.com unless you want me to do a GitHub Pages-based deployment, which I've also done just recently for WWDC Notes, see here.

Please let me know if you have other plans for the docs or if I should continue with my suggestion.

[twostraws]

I'm sorry you feel the current documentation is incomplete, but I have very little interest in pursuing DocC for Ignite documentation.

I spent a great deal of time building https://ignitesamples.hackingwithswift.com, which a) shows off almost every element type and modifier, b) provides the code used to create each sample, and c) is written entirely in Ignite; I'd much rather improve that if something is missing.

The benefit of having it built in Ignite is that folks can literally take our sample code as-is and use it however they want – it's neatly recursive, and also acts as a demo site for folks who want to see what Ignite can do.

[Jeehut]

Fair enough, I do understand the point to use Ignite for its own documentation. But then I have a couple of suggestions:

1. Instead of calling the site 'Ignite Examples' I suggest making it the official 'Ignite Documentation'
2. The Getting Started guide from the README should live there as well in a 'Guides' section
3. Instead of 'Examples' there should be sections with all components listed, easy to look up things
4. For dedicated articles explaining multiple components that belong together, the 'Guides' section could be used
5. An 'Examples' section could be reintroduced for entire real-world use cases like an app landing page, a blog, etc.

Due to these points above, the examples site doesn't feel like documentation to me. For example, I was looking for a way to add metadata to my pages for SEO purposes, but I couldn't find the MetaTag component there. So I looked for the word "documentation" on the Ignite repo and couldn't find anything that lead to more info. It should be listed somewhere though and a dedicated guide on topics like "SEO", "Deployment", or "File structure" could be very useful as well.

Much like Vapor has guides on different topics, including dedicated instructions for common deployment providers. I found their guided & structured documentation very helpful in piecemeal adoption of a new technology I've never used before.

Creating websites is a complex topic with many aspects to consider and learn about. A README and a website with an incomplete list of alphabetically ordered component explanations doesn't seem to make it justice. At least there are some things missing, even if you don't agree with my renaming suggestions.

I hope I could help clarify why I created this issue in the first place. If you closed it only because you disagree with my DocC suggestion, I would appreciate if you opened it again until the incomplete docs are fixed. I removed DocC from the title.