Where should tutorial go?

[dorfsmay]

Where is the source for http://ironframework.io ?

Where should tutorials and more in-depths explanation go?

Just doc strings isn't sufficient, I feel like I have to google for hours to understand concepts about Iron, and from comments I see on blogs etc... I'm not the only one.

[untitaker]

That website is hosted at https://github.com/iron/iron.github.io

I think we could add some links to third-party tutorials until we have a dedicated website for this.

[dorfsmay]

Why not starting an area now? Even if it's not pretty, it'll encourage people to add to it as they learn. In fact not being pretty might irk somebody enough to improve it!

[dorfsmay]

Another issue with linking to blogs etc... is time rot. As Iron is getting changed, external blogs won't be updated, while internal docs have both more chances to be updated and getting complaints about (and being updated as a consequence).

[untitaker]

If you have the time to create a new website I would apprechiate it! The problem with the current one is that it is IMO barely extensible. We should switch to a popular static site generator.

[dorfsmay]

I'd go one step further, let's pic a popular markup in order not to be coupled with a tool.

Any suggestions?

[untitaker]

I dont understand what you mean. We already use markdown, partially.

…

On April 14, 2017 4:14:22 PM GMT+02:00, Yves Dorfsman ***@***.***> wrote: I'd go one step further, let's pic a popular markup in order not to be coupled with a tool. Any suggestions? -- You are receiving this because you commented. Reply to this email directly or view it on GitHub: #535 (comment)

-- Sent from my Android device with K-9 Mail. Please excuse my brevity.

[dorfsmay]

What I meant was to be careful not getting into specialized markup that comes, and can only be rendered, with a specific tool. Any suggestion for a tool?

[untitaker]

We will need to settle for some generator whether we like it or not. AFAIK Markdown doesn't have any syntax for e.g. cross references. I had Hugo or Lektor in mind, but I don't know which one would be more popular.

…

On Fri, Apr 14, 2017 at 07:22:46AM -0700, Yves Dorfsman wrote: What I meant was to be careful not getting into specialized markup that comes, and can only be rendered, with a specific tool. Any suggestion for a tool? -- You are receiving this because you commented. Reply to this email directly or view it on GitHub: #535 (comment)

[Hoverbear]

What hosts the site? If it's Github pages they have built in jekyll support for repos.

[untitaker]

It is GitHub pages, but we can use Travis to build anything.

[Technius]

Is there an issue tracking a list of things to be documented? I'd like to contribute, but I'm not quite sure where to begin.

[untitaker]

There is no official, but if you ask on the /r/rust subreddit I'm sure somebody will be happy to give you a very detailed answer on what's wrong with Iron's docs :)

…

On Sat, Apr 15, 2017 at 11:03:15AM -0700, Bryan Tan wrote: Is there an issue tracking a list of things to be documented? I'd like to contribute, but I'm not quite sure where to begin. -- You are receiving this because you commented. Reply to this email directly or view it on GitHub: #535 (comment)