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

Replace Dottydoc with Tastydoc #7668

Closed
abgruszecki opened this issue Dec 2, 2019 · 13 comments
Closed

Replace Dottydoc with Tastydoc #7668

abgruszecki opened this issue Dec 2, 2019 · 13 comments

Comments

@abgruszecki
Copy link
Contributor

abgruszecki commented Dec 2, 2019

This is an issue to discuss replacing Scaladoc with Tastydoc.

Tastydoc has a similar intermediate reprentation of code as Dottydoc, so the remaining work is to copy over the HTML "backend" from Dottydoc to Tastydoc, and to change the plumbing so that we use Tastydoc to generate dotty.epfl.ch. @BryanAbate any corrections/additions to the above are welcome.

@TheElectronWill If I understand correctly, you'd be interested in contributing the above? If so, this issue would be the place to keep us updated on the status of your work and ask us questions. IIRC, @BryanAbate has offered to help you in understanding Tastydoc internals (thanks Bryan!).

@BryanAbate
Copy link
Contributor

BryanAbate commented Dec 3, 2019

I confirm that the intermediate representation of Tastydoc is pretty similar to Dottydoc and that I offer my help to understand Tastydoc if needed.
If anyone need a particular change/addition to the API I can work on that as well.

@TheElectronWill
Copy link
Member

Thank you to both of you!
I confirm my interest in contributing to this. I'll keep you updated.
To be sure: when you say Scaladoc here, do you actually mean Dottydoc (and not Scala 2's scaladoc)?

@abgruszecki
Copy link
Contributor Author

You're completely correct @TheElectronWill, there's too many *Docs here :) Fix'd the original post.

@TheElectronWill TheElectronWill changed the title Replace Scaladoc with Tastydoc Replace Dottydoc with Tastydoc Dec 4, 2019
@TheElectronWill
Copy link
Member

TheElectronWill commented Jun 29, 2020

I've started to work on this 😃
I've updated the paths in tastydoc tests and got a failure for dotty library (minimized in #9259). I'll probably fix those bugs first and then integrate the html generation.

@TheElectronWill TheElectronWill self-assigned this Jun 29, 2020
@abgruszecki
Copy link
Contributor Author

@TheElectronWill unfortunately we've decided to enlist a developer to fully develop a documentation tool for Dotty - a documentation tool is a pretty important thing for a language, after all. Thanks for your offer of help!

@TheElectronWill
Copy link
Member

np! A dedicated developer will lead to a better tool in the end, so that’s good news.

@TheElectronWill TheElectronWill removed their assignment Jun 30, 2020
@abgruszecki
Copy link
Contributor Author

@TheElectronWill In order to keep you updated, we will be starting work on the doctool around July 20th. After initial period of quick development (2-3 weeks), we're likely to have a good picture of the remaining work and we may have precise issues where your help could be handy. One area where you probably could lend us a hand is styling the output of the tool, since you already know HTML/CSS. Let me know if you'd still be willing to help us out around the beginning of August and I'll keep you updated.

@TheElectronWill
Copy link
Member

Thanks for the update!
I'm willing to help at the beginning of August :-)

@abgruszecki
Copy link
Contributor Author

@TheElectronWill could you send me your email address? We're going to send an introductory email to all the people who'd potentially be interested in contributing to the doc-tool (which also includes you Bryan, in case you're reading this :) ).

@TheElectronWill
Copy link
Member

@AleksanderBG I've just sent you an email

@bishabosha
Copy link
Member

@abgruszecki is there some other task before we can close this?

@abgruszecki
Copy link
Contributor Author

@bishabosha well, I believe we still need to replace Dottydoc with Tastydoc (:P), afterwards I guess this one can be closed.

@bishabosha
Copy link
Member

@abgruszecki how about now?

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

No branches or pull requests

4 participants