Re: [akka-user] New Documentation

[Patrik Nordwall]

Adding an API link somewhere to the left would be nice. I'm not sure where
it would fit. Let's discuss in https://github.com/akka/akka/issues/23053

Inline links should be added, see https://github.com/akka/akka/issues/22904

We can also use side bar notes to link to related API docs, see
https://github.com/akka/akka/issues/22906

Slightly related is that we want to consolidate the Scala and Java content
into same .md file, see https://github.com/akka/akka/issues/23052

Contributions of these things are very welcome. It can be done one page at
a time, pick your favorite.

Cheers,
Patrik

On Sun, May 28, 2017 at 6:39 PM, Roland Kuhn  wrote:

> Hi Mike,
>
> it took a bit until your proposal registered properly (I blame the sun): I
> agree that it would be nice to have a link to the API on every page of the
> reference docs, I’ve seen that elsewhere and it makes sense. It would be
> even nicer to have everything in the code samples linked to its API doc
> where applicable :-) Does such technology exist today?
>
> Regards,
>
> Roland
>
> 28 maj 2017 kl. 18:05 skrev Mike Nielsen :
>
> I'm sure it is for all but those of us like me who are intensely lazy.
>
> I just thought it would be handy to have the nav header version in the
> reference link to the API docs.
>
> No biggie, really.
>
> Again, let me congratulate you on the new site.  I think it's outstanding,
> and I am very excited about the possibility that there may be more runnable
> examples using ScalaFiddle!
>
> Well done and thank you for taking the time on a Sunday to reply!
>
> Warm regards,
>
> Mike
>
> On Sun, May 28, 2017 at 9:33 AM, Patrik Nordwall <
> patrik.nordw...@gmail.com> wrote:
>
>> Thanks. Our thinking was that http://akka.io/docs/ would be the landing
>> page for all docs including such links. Not enough?
>>
>> /Patrik
>> sön 28 maj 2017 kl. 15:26 skrev Mike Nielsen :
>>
>>> Congratulations, team, on the new Akka documentation site.  It looks
>>> good!
>>>
>>> By way of a minor enhancement, would it be possible to put a link to the
>>> API documentation in an easy-to-find place so that those of us with poor
>>> memories may find it more easily?
>>>
>>> Thanks!
>>>
>>> --
>>> >> Read the docs: http://akka.io/docs/
>>> >> Check the FAQ: http://doc.akka.io/docs/akka/c
>>> urrent/additional/faq.html
>>> >> Search the archives: https://groups.google.com/grou
>>> p/akka-user
>>> ---
>>> You received this message because you are subscribed to the Google
>>> Groups "Akka User List" group.
>>> To unsubscribe from this group and stop receiving emails from it, send
>>> an email to akka-user+unsubscr...@googlegroups.com.
>>> To post to this group, send email to akka-user@googlegroups.com.
>>> Visit this group at https://groups.google.com/group/akka-user.
>>> For more options, visit https://groups.google.com/d/optout.
>>>
>>
>> --
>> >> Read the docs: http://akka.io/docs/
>> >> Check the FAQ: http://doc.akka.io/docs/akka/c
>> urrent/additional/faq.html
>> >> Search the archives: https://groups.google.com/group/akka-user
>> ---
>> You received this message because you are subscribed to the Google Groups
>> "Akka User List" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to akka-user+unsubscr...@googlegroups.com.
>> To post to this group, send email to akka-user@googlegroups.com.
>> Visit this group at https://groups.google.com/group/akka-user.
>> For more options, visit https://groups.google.com/d/optout.
>>
>
>
> --
> >> Read the docs: http://akka.io/docs/
> >> Check the FAQ: http://doc.akka.io/docs/akka/
> current/additional/faq.html
> >> Search the archives: https://groups.google.com/group/akka-user
> ---
> You received this message because you are subscribed to the Google Groups
> "Akka User List" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to akka-user+unsubscr...@googlegroups.com.
> To post to this group, send email to akka-user@googlegroups.com.
> Visit this group at https://groups.google.com/group/akka-user.
> For more options, visit https://groups.google.com/d/optout.
>
>
> --
> >> Read the docs: http://akka.io/docs/
> >> Check the FAQ: http://doc.akka.io/docs/akka/
> current/additional/faq.html
> >> Search the archives: https://groups.google.com/group/akka-user
> ---
> You received this message because you are subscribed to the Google Groups
> "Akka User List" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to akka-user+unsubscr...@googlegroups.com.
> To post to this group, send email to akka-user@googlegroups.com.
> Visit this group at https://groups.google.com/group/akka-user.
> For more options, visit https://groups.google.com/d/optout.
>



-- 

Patrik Nordwall
Akka Tech Lead
Lightbend  -  Reactive apps on the JVM

Re: [akka-user] New Documentation

[Roland Kuhn]

Hi Mike,

it took a bit until your proposal registered properly (I blame the sun): I 
agree that it would be nice to have a link to the API on every page of the 
reference docs, I’ve seen that elsewhere and it makes sense. It would be even 
nicer to have everything in the code samples linked to its API doc where 
applicable :-) Does such technology exist today?

Regards,

Roland

> 28 maj 2017 kl. 18:05 skrev Mike Nielsen :
> 
> I'm sure it is for all but those of us like me who are intensely lazy.
> 
> I just thought it would be handy to have the nav header version in the 
> reference link to the API docs.
> 
> No biggie, really. 
> 
> Again, let me congratulate you on the new site.  I think it's outstanding, 
> and I am very excited about the possibility that there may be more runnable 
> examples using ScalaFiddle!
> 
> Well done and thank you for taking the time on a Sunday to reply!
> 
> Warm regards,
> 
> Mike
> 
> On Sun, May 28, 2017 at 9:33 AM, Patrik Nordwall  > wrote:
> Thanks. Our thinking was that http://akka.io/docs/  
> would be the landing page for all docs including such links. Not enough?
> 
> /Patrik
> sön 28 maj 2017 kl. 15:26 skrev Mike Nielsen  >:
> Congratulations, team, on the new Akka documentation site.  It looks good!
> 
> By way of a minor enhancement, would it be possible to put a link to the API 
> documentation in an easy-to-find place so that those of us with poor memories 
> may find it more easily?
> 
> Thanks!
> 
> -- 
> >> Read the docs: http://akka.io/docs/ 
> >> Check the FAQ: 
> >> http://doc.akka.io/docs/akka/current/additional/faq.html 
> >> 
> >> Search the archives: https://groups.google.com/group/akka-user 
> >> 
> --- 
> You received this message because you are subscribed to the Google Groups 
> "Akka User List" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to akka-user+unsubscr...@googlegroups.com 
> .
> To post to this group, send email to akka-user@googlegroups.com 
> .
> Visit this group at https://groups.google.com/group/akka-user 
> .
> For more options, visit https://groups.google.com/d/optout 
> .
> 
> -- 
> >> Read the docs: http://akka.io/docs/ 
> >> Check the FAQ: 
> >> http://doc.akka.io/docs/akka/current/additional/faq.html 
> >> 
> >> Search the archives: https://groups.google.com/group/akka-user 
> >> 
> --- 
> You received this message because you are subscribed to the Google Groups 
> "Akka User List" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to akka-user+unsubscr...@googlegroups.com 
> .
> To post to this group, send email to akka-user@googlegroups.com 
> .
> Visit this group at https://groups.google.com/group/akka-user 
> .
> For more options, visit https://groups.google.com/d/optout 
> .
> 
> 
> -- 
> >> Read the docs: http://akka.io/docs/ 
> >> Check the FAQ: 
> >> http://doc.akka.io/docs/akka/current/additional/faq.html 
> >> 
> >> Search the archives: https://groups.google.com/group/akka-user 
> >> 
> --- 
> You received this message because you are subscribed to the Google Groups 
> "Akka User List" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to akka-user+unsubscr...@googlegroups.com 
> .
> To post to this group, send email to akka-user@googlegroups.com 
> .
> Visit this group at https://groups.google.com/group/akka-user 
> .
> For more options, visit https://groups.google.com/d/optout 
> .

-- 
>>  Read the docs: http://akka.io/docs/
>>  Check the FAQ: 
>> http://doc.akka.io/docs/akka/current/additional/faq.html
>>  Search the archives: https://groups.google.com/group/akka-user
--- 
You received this message because you are subscribed to the Google Groups "Akka 
User List" group.
To unsubscribe from this group and 

Re: [akka-user] New Documentation

[Mike Nielsen]

I'm sure it is for all but those of us like me who are intensely lazy.

I just thought it would be handy to have the nav header version in the
reference link to the API docs.

No biggie, really.

Again, let me congratulate you on the new site.  I think it's outstanding,
and I am very excited about the possibility that there may be more runnable
examples using ScalaFiddle!

Well done and thank you for taking the time on a Sunday to reply!

Warm regards,

Mike

On Sun, May 28, 2017 at 9:33 AM, Patrik Nordwall 
wrote:

> Thanks. Our thinking was that http://akka.io/docs/ would be the landing
> page for all docs including such links. Not enough?
>
> /Patrik
> sön 28 maj 2017 kl. 15:26 skrev Mike Nielsen :
>
>> Congratulations, team, on the new Akka documentation site.  It looks good!
>>
>> By way of a minor enhancement, would it be possible to put a link to the
>> API documentation in an easy-to-find place so that those of us with poor
>> memories may find it more easily?
>>
>> Thanks!
>>
>> --
>> >> Read the docs: http://akka.io/docs/
>> >> Check the FAQ: http://doc.akka.io/docs/akka/
>> current/additional/faq.html
>> >> Search the archives: https://groups.google.com/group/akka-user
>> ---
>> You received this message because you are subscribed to the Google Groups
>> "Akka User List" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to akka-user+unsubscr...@googlegroups.com.
>> To post to this group, send email to akka-user@googlegroups.com.
>> Visit this group at https://groups.google.com/group/akka-user.
>> For more options, visit https://groups.google.com/d/optout.
>>
> --
> >> Read the docs: http://akka.io/docs/
> >> Check the FAQ: http://doc.akka.io/docs/akka/
> current/additional/faq.html
> >> Search the archives: https://groups.google.com/group/akka-user
> ---
> You received this message because you are subscribed to the Google Groups
> "Akka User List" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to akka-user+unsubscr...@googlegroups.com.
> To post to this group, send email to akka-user@googlegroups.com.
> Visit this group at https://groups.google.com/group/akka-user.
> For more options, visit https://groups.google.com/d/optout.
>

-- 
>>  Read the docs: http://akka.io/docs/
>>  Check the FAQ: 
>> http://doc.akka.io/docs/akka/current/additional/faq.html
>>  Search the archives: https://groups.google.com/group/akka-user
--- 
You received this message because you are subscribed to the Google Groups "Akka 
User List" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to akka-user+unsubscr...@googlegroups.com.
To post to this group, send email to akka-user@googlegroups.com.
Visit this group at https://groups.google.com/group/akka-user.
For more options, visit https://groups.google.com/d/optout.

Re: [akka-user] New Documentation

[Patrik Nordwall]

Thanks. Our thinking was that http://akka.io/docs/ would be the landing
page for all docs including such links. Not enough?

/Patrik
sön 28 maj 2017 kl. 15:26 skrev Mike Nielsen :

> Congratulations, team, on the new Akka documentation site.  It looks good!
>
> By way of a minor enhancement, would it be possible to put a link to the
> API documentation in an easy-to-find place so that those of us with poor
> memories may find it more easily?
>
> Thanks!
>
> --
> >> Read the docs: http://akka.io/docs/
> >> Check the FAQ:
> http://doc.akka.io/docs/akka/current/additional/faq.html
> >> Search the archives: https://groups.google.com/group/akka-user
> ---
> You received this message because you are subscribed to the Google Groups
> "Akka User List" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to akka-user+unsubscr...@googlegroups.com.
> To post to this group, send email to akka-user@googlegroups.com.
> Visit this group at https://groups.google.com/group/akka-user.
> For more options, visit https://groups.google.com/d/optout.
>

-- 
>>  Read the docs: http://akka.io/docs/
>>  Check the FAQ: 
>> http://doc.akka.io/docs/akka/current/additional/faq.html
>>  Search the archives: https://groups.google.com/group/akka-user
--- 
You received this message because you are subscribed to the Google Groups "Akka 
User List" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to akka-user+unsubscr...@googlegroups.com.
To post to this group, send email to akka-user@googlegroups.com.
Visit this group at https://groups.google.com/group/akka-user.
For more options, visit https://groups.google.com/d/optout.

[akka-user] New Documentation

[Mike Nielsen]

Congratulations, team, on the new Akka documentation site.  It looks good!

By way of a minor enhancement, would it be possible to put a link to the
API documentation in an easy-to-find place so that those of us with poor
memories may find it more easily?

Thanks!

-- 
>>  Read the docs: http://akka.io/docs/
>>  Check the FAQ: 
>> http://doc.akka.io/docs/akka/current/additional/faq.html
>>  Search the archives: https://groups.google.com/group/akka-user
--- 
You received this message because you are subscribed to the Google Groups "Akka 
User List" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to akka-user+unsubscr...@googlegroups.com.
To post to this group, send email to akka-user@googlegroups.com.
Visit this group at https://groups.google.com/group/akka-user.
For more options, visit https://groups.google.com/d/optout.