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

Add online documentation/wiki. #7

Open
Ayfri opened this issue Jan 30, 2023 · 4 comments
Open

Add online documentation/wiki. #7

Ayfri opened this issue Jan 30, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Ayfri
Copy link
Owner

Ayfri commented Jan 30, 2023

No description provided.

@Ayfri Ayfri added the documentation Improvements or additions to documentation label Jan 30, 2023
@Ayfri Ayfri self-assigned this Jan 30, 2023
@AugustinMauroy
Copy link
Contributor

If you want I can create a Nextjs infra.

With this feature:

  • Docs search
  • I18n (deploy with vercel)
  • ReactJS
  • Deploy with GitHub page.

@Ayfri
Copy link
Owner Author

Ayfri commented Mar 24, 2023

For the documentation/wiki, it might be better to create everything in Kotlin, just for the beauty of the thing, but if you have arguments for why NextJS would be better I'm okay to discuss !

The documentation will surely be created using Dokka, but for the wiki I might use Compose Web, as I already know how to use it (I actually never used ReactJS, almost all of my websites are in pure HTML/JS/CSS and sometimes Go or Kotlin for the back).

Also, for now it's not important that we create an online documentation as the code don't have any documentation (maybe a very few methods have but it's far from enough), but I'm okay with creating a guide !

@AugustinMauroy
Copy link
Contributor

Start writing markdown on docs directory. And the infra will come later.

@AugustinMauroy
Copy link
Contributor

FYI: the kotlin website is created with react

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 📋 To do
Development

No branches or pull requests

2 participants