[ruby-core:118621] [Ruby master Misc#20639] Request to host C API docs on docs.ruby-lang.org

[ruby-core:118621] [Ruby master Misc#20639] Request to host C API docs on docs.ruby-lang.org

[alanwu (Alan Wu) via ruby-core]

Issue #20639 has been reported by alanwu (Alan Wu).

----------------------------------------
Misc #20639: Request to host C API docs on docs.ruby-lang.org
https://bugs.ruby-lang.org/issues/20639

* Author: alanwu (Alan Wu)
* Status: Open
----------------------------------------
Having a first-party documentation site benefits readers and helps
contributors improve the contents. The Ruby standard library API benefits from
being hosted on <https://docs.ruby-lang.org> and it would be nice if the C API
documentation produced by Doxygen can be hosted on the same site as well.

I'm not familiar with the logistics of hosting the documentation site, and traffic
is not free. But I think this is worth considering for the benefit of Ruby
extension authors and maintainers.

At the moment, <https://github.com/ruby/actions> generates the documentation with
Doxygen but it's not hosted anywhere as far as I can tell. Searching for
"Ruby C API documentation" on Google lead to guides about the API and no results
that provide a comprehensive up-to-date reference.



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

[ruby-core:118622] [Ruby master Misc#20639] Request to host C API docs on docs.ruby-lang.org

[znz (Kazuhiro NISHIYAMA) via ruby-core]

Issue #20639 has been updated by znz (Kazuhiro NISHIYAMA).


They hosted on S3 directly (URLs can be deduced from the workflow file), but they are not for public now.

I agree to serve them on docs.ruby-lang.org.

We want to consider their URL before serving.

Current paths are:

* `/en/VERSION/` for rdoc
* `/ja/VERSION/` for rurema
* `/ja/search/` for rurema-search

What path is good for documents generated by Doxygen?

----------------------------------------
Misc #20639: Request to host C API docs on docs.ruby-lang.org
https://bugs.ruby-lang.org/issues/20639#change-109148

* Author: alanwu (Alan Wu)
* Status: Open
----------------------------------------
Having a first-party documentation site benefits readers and helps
contributors improve the contents. The Ruby standard library API benefits from
being hosted on <https://docs.ruby-lang.org> and it would be nice if the C API
documentation produced by Doxygen can be hosted on the same site as well.

I'm not familiar with the logistics of hosting the documentation site, and traffic
is not free. But I think this is worth considering for the benefit of Ruby
extension authors and maintainers.

At the moment, <https://github.com/ruby/actions> generates the documentation with
Doxygen but it's not hosted anywhere as far as I can tell. Searching for
"Ruby C API documentation" on Google lead to guides about the API and no results
that provide a comprehensive up-to-date reference.



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

[ruby-core:118627] [Ruby master Misc#20639] Request to host C API docs on docs.ruby-lang.org

[alanwu (Alan Wu) via ruby-core]

Issue #20639 has been updated by alanwu (Alan Wu).


I think `/capi/en/VERSION` is a good starting point.

----------------------------------------
Misc #20639: Request to host C API docs on docs.ruby-lang.org
https://bugs.ruby-lang.org/issues/20639#change-109154

* Author: alanwu (Alan Wu)
* Status: Open
----------------------------------------
Having a first-party documentation site benefits readers and helps
contributors improve the contents. The Ruby standard library API benefits from
being hosted on <https://docs.ruby-lang.org> and it would be nice if the C API
documentation produced by Doxygen can be hosted on the same site as well.

I'm not familiar with the logistics of hosting the documentation site, and traffic
is not free. But I think this is worth considering for the benefit of Ruby
extension authors and maintainers.

At the moment, <https://github.com/ruby/actions> generates the documentation with
Doxygen but it's not hosted anywhere as far as I can tell. Searching for
"Ruby C API documentation" on Google lead to guides about the API and no results
that provide a comprehensive up-to-date reference.



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

[ruby-core:118629] [Ruby master Misc#20639] Request to host C API docs on docs.ruby-lang.org

[hsbt (Hiroshi SHIBATA) via ruby-core]

Issue #20639 has been updated by hsbt (Hiroshi SHIBATA).

Status changed from Open to Assigned
Assignee set to znz (Kazuhiro NISHIYAMA)

I'm +1 for this request.

@znz Please let me know if you need to my support.

----------------------------------------
Misc #20639: Request to host C API docs on docs.ruby-lang.org
https://bugs.ruby-lang.org/issues/20639#change-109156

* Author: alanwu (Alan Wu)
* Status: Assigned
* Assignee: znz (Kazuhiro NISHIYAMA)
----------------------------------------
Having a first-party documentation site benefits readers and helps
contributors improve the contents. The Ruby standard library API benefits from
being hosted on <https://docs.ruby-lang.org> and it would be nice if the C API
documentation produced by Doxygen can be hosted on the same site as well.

I'm not familiar with the logistics of hosting the documentation site, and traffic
is not free. But I think this is worth considering for the benefit of Ruby
extension authors and maintainers.

At the moment, <https://github.com/ruby/actions> generates the documentation with
Doxygen but it's not hosted anywhere as far as I can tell. Searching for
"Ruby C API documentation" on Google lead to guides about the API and no results
that provide a comprehensive up-to-date reference.



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

[ruby-core:118687] [Ruby master Misc#20639] Request to host C API docs on docs.ruby-lang.org

[znz (Kazuhiro NISHIYAMA) via ruby-core]

Issue #20639 has been updated by znz (Kazuhiro NISHIYAMA).


I added <https://docs.ruby-lang.org/capi/en/master/> and link from <https://docs.ruby-lang.org/> to it.

----------------------------------------
Misc #20639: Request to host C API docs on docs.ruby-lang.org
https://bugs.ruby-lang.org/issues/20639#change-109223

* Author: alanwu (Alan Wu)
* Status: Assigned
* Assignee: znz (Kazuhiro NISHIYAMA)
----------------------------------------
Having a first-party documentation site benefits readers and helps
contributors improve the contents. The Ruby standard library API benefits from
being hosted on <https://docs.ruby-lang.org> and it would be nice if the C API
documentation produced by Doxygen can be hosted on the same site as well.

I'm not familiar with the logistics of hosting the documentation site, and traffic
is not free. But I think this is worth considering for the benefit of Ruby
extension authors and maintainers.

At the moment, <https://github.com/ruby/actions> generates the documentation with
Doxygen but it's not hosted anywhere as far as I can tell. Searching for
"Ruby C API documentation" on Google lead to guides about the API and no results
that provide a comprehensive up-to-date reference.



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/

[ruby-core:118781] [Ruby master Misc#20639] Request to host C API docs on docs.ruby-lang.org

[alanwu (Alan Wu) via ruby-core]

Issue #20639 has been updated by alanwu (Alan Wu).

Status changed from Assigned to Closed

Thanks very much!
We can now work on making the docs even better over time.

----------------------------------------
Misc #20639: Request to host C API docs on docs.ruby-lang.org
https://bugs.ruby-lang.org/issues/20639#change-109333

* Author: alanwu (Alan Wu)
* Status: Closed
* Assignee: znz (Kazuhiro NISHIYAMA)
----------------------------------------
Having a first-party documentation site benefits readers and helps
contributors improve the contents. The Ruby standard library API benefits from
being hosted on <https://docs.ruby-lang.org> and it would be nice if the C API
documentation produced by Doxygen can be hosted on the same site as well.

I'm not familiar with the logistics of hosting the documentation site, and traffic
is not free. But I think this is worth considering for the benefit of Ruby
extension authors and maintainers.

At the moment, <https://github.com/ruby/actions> generates the documentation with
Doxygen but it's not hosted anywhere as far as I can tell. Searching for
"Ruby C API documentation" on Google lead to guides about the API and no results
that provide a comprehensive up-to-date reference.



-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/lists/ruby-core.ml.ruby-lang.org/