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

Rewrite website using modern Static Site Documentation website Generator Docusaurus or Astro #21

Open
friday opened this issue Apr 2, 2024 · 4 comments

Comments

@friday
Copy link
Member

friday commented Apr 2, 2024

Two good options:

Other thoughts

  • It should be hosted on GitHub pages, to make it free to host and easy to deploy (GitHub pages can use custom domains).
  • GitHub Actions should redeploy it when we update the main branch and maybe other branches.
  • This will substitute both the website and the ReadTheDocs, and give us more control and better UX than RTD (and also being able to rebuild the documentation for old versions).
  • We only want the documentation generator to cover the extension API, not most of the app like now.
  • We can move the v6 extension submissions to a GitHub Discussions category and use GitHub workflows to validate submissions and rebuild the page with the GitHub GraphQL APIs Move ext.ulauncher.io over here as a category Ulauncher#915.
  • We can do the same for Themes (instead of https://gist.github.com/gornostal/02a232e6e560da7946c053555ced6cce).
@marvelxcodes
Copy link

Can you assign me to rebuild the website with Astro?

@gornostal
Copy link
Member

@marvelxcodes I'll be happy to assist.

Feel free to post questions here. They don't have to be specific. That will help me understand what kind of assistance you need.

Of course, one of the first things would be to find/buy a theme so we don't have to create design and write CSS. I can definitely help with that

@friday
Copy link
Member Author

friday commented Jul 7, 2024

Thanks for offering to help out 👍 I think this is something we have to set up first before someone can contribute, so I just made a repo for this and migrated docs (or at least most of them): https://github.com/Ulauncher/astro-docs

image

The main page is basically the astro startlight boilerplate page still. If you want to offer help migrating the content and layout from the ulauncher.io page or have createive suggestions for how to improve it otherwise, feel free to help.

I think of this issue and the repo as an experiment and I'm not sure how far we can take it, but we should definitely be able to replace the website and the ReadTheDocs. The other parts will be harder.

This one has no generated code at all, and I'm not sure how much we really need that for Ulauncher v6 since the api has been much simplified (I think some of the docs pages should be simplified more if anything).

There's also quite a lot of things with how to deploy, update, maybe keep versions of the documentation that needs to be figured out, but I think that's hard for a first time contributor.

Also might need a licence for it, even if it's just a docs site.

@gornostal
Copy link
Member

Thank you!

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

No branches or pull requests

3 participants