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

proof of concept up and running #429

Open
finanalyst opened this issue Jan 12, 2025 · 5 comments
Open

proof of concept up and running #429

finanalyst opened this issue Jan 12, 2025 · 5 comments

Comments

@finanalyst
Copy link
Collaborator

@coke @dontlaugh @librasteve @lizmat @Raku/docteam

A proof of concept of a replacement to Collection, running on the new Rakuast::RakuDoc::Render, is now on line in a container example on new-raku

Only a few pages (~20) have been included

What it shows:

  1. A multi-lingual interface. Currently English, French, Dutch, Ukrainian, Welsh, Japanese are implemented
  • Tokens are created using google translate, so will need adjusting
  • The idea shows how the interface language can be separated from the content language
  1. Much better responsiveness to Tablet and Mobile formats.
  • The overlaps at the tablet size between content panel and ToC panel have gone.
  • Changing formats on the fly takes significant browser resources, so changing size quickly can cause format glitches
  1. Some format glitches were also caused because there was too much in the top navigation bar.
  • I have moved Types, Routines, Chat, to More
  • Also I have put Theme change in More
  1. The beginning of Multilingual content.
  • The only content is currently English. However, it all resides under the en/ directory.
  • Clicking on the Camelia icon in a normal page takes you to the 'index' for the language
  • Clicking on the Camelia icon in the index page takes you to the multilingual index page.
  1. Bulma's CSS native theme change is in use.
  • The theme change has a different range of colours than we have in docs.raku.org
  • The theme also changes the coloration of highlighted code.
  • Bulma allows for custom themes, but I have not given any attention to this yet. Feedback is needed to see whether the colours in the standard two schemes are acceptible, or so bad its worth creating new themes sooner rather than later.

What remains

  1. The index page for the English will be made to look more like the docs.raku.org site index, the changes are all CSS in nature
  2. Search, Composites and some custom blocks for the Types and Routines have yet to happen, and various other things need implementing.

Lots remains to be done, but this is just to show the progress so far. I hope the community likes and approves the direction.

@coke
Copy link
Contributor

coke commented Jan 12, 2025

Looks great; much better responsiveness at different sizes, well done.

@dontlaugh
Copy link
Collaborator

Any chance the code that generates the website can live in the Raku org this time? The fact that it hasn't is - I suspect - one of the reasons it's been so hard to work on.

@finanalyst
Copy link
Collaborator Author

@dontlaugh not sure I understand what you mean

@dontlaugh
Copy link
Collaborator

dontlaugh commented Jan 13, 2025

Two things, mostly. The first is a concern about software architecture. The second is about governance.

First, I think it's too early to extract this as a standalone framework. I think you'll get a more maintainable design by moving all that code into this repo, and we refine it together. If the source material of Raku/doc is the only serious user of the elucid8 code that makes a website, let's iterate on that design together (in this repo). It doesn't prevent us from extracting a framework later.

Second, even if we do have new repositories, I think they ought to at least begin their life in the Raku github organization.

Those are my two cents, at least for the early phases of a project like this. That said, I won't fight about it. If no one else feels strongly, I'll support your site rewrite in general: with testing, builds, CI, and deployment.

@finanalyst
Copy link
Collaborator Author

@dontlaugh There are some reasons for extracting this to another repo. I'd prefer to discuss them off-line at the moment. When would you be available for a Zoom/Jitsii call?
I understand both your concerns, and I would value your feedback on both.

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