Comments (2)
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.
from ignite.
Fair enough, I do understand the point to use Ignite for its own documentation. But then I have a couple of suggestions:
- Instead of calling the site 'Ignite Examples' I suggest making it the official 'Ignite Documentation'
- The Getting Started guide from the README should live there as well in a 'Guides' section
- Instead of 'Examples' there should be sections with all components listed, easy to look up things
- For dedicated articles explaining multiple components that belong together, the 'Guides' section could be used
- 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.
from ignite.
Related Issues (20)
- Deploy & Build error when install Ignite HOT 1
- Build Error on Linux HOT 2
- `addCustomAttribute` not working on `MetaLink`s
- Feature Request: Add capability to make links open their targets in new browser tabs. HOT 3
- To explore: How simple can Ignite sites be?
- Close Button
- Adding localization support to improve accessibility HOT 12
- Change to `enum Target` for `case blank` HOT 2
- Swift 6 build fails HOT 5
- Getting warnings about swift-driver
- Support custom install locations in Makefile
- Question: supporting alternative css frameworks, such as tailwindcss HOT 3
- Feature / Image Content Mode HOT 1
- Simple line breaks in markdown or using `Text()` HOT 4
- Feature Request: add Ignite to Homebrew
- Potential Workflow Improving Changes HOT 4
- Is it possible to add multiple items to a NavigationBar logo? HOT 1
- Bug: < and > are removed in markdown code snippets HOT 3
- How to make a whole card or image as a link? HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ignite.