Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What, Why, and Backend in AsciiDoc new users guide #3

Closed
graphitefriction opened this issue Mar 13, 2013 · 3 comments
Closed

What, Why, and Backend in AsciiDoc new users guide #3

graphitefriction opened this issue Mar 13, 2013 · 3 comments

Comments

@graphitefriction
Copy link
Member

As the goal of the new users guide is to be brief and to get them writing in AsciiDoc ASAP, I think most of the content prior to the Writing in AsciiDoc: First Steps section is just way too much backstory.

What do people think of removing most of that content and instead use it to create "What is AsciiDoc", "Why Use AsciiDoc", "How AsciiDoc Renders your Opus" guides?

@mojavelinux
Copy link
Member

I think that's the right way to go. Once we setup the website build, it will be much easier to tie the various documents together, perhaps so they flow very naturally from one to the next. We could even think of them as chapters of a book.

The backstory is important in this case (even though I'm often critical of backstory) because the first question I always get asked is "What is AsciiDoc?" and "Why should I use AsciiDoc (instead of Markdown)?" It will be good to get these responses out there.

mojavelinux pushed a commit to mojavelinux/asciidoctor.org that referenced this issue May 31, 2013
intro, thanks, write faster section, font awesome section
@graphitefriction
Copy link
Member Author

Convert this discussion to roadmap goal of automating documentation updates and combining all the Docs into One Big Book of Asciidoctor. Then close this issue as it has diverged from its title.

@graphitefriction
Copy link
Member Author

Documented in Docs repo wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants