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 LostUser's Readme to OpenComputers' manual #391

Open
ZZZank opened this issue Jul 7, 2024 · 4 comments
Open

Add LostUser's Readme to OpenComputers' manual #391

ZZZank opened this issue Jul 7, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@ZZZank
Copy link

ZZZank commented Jul 7, 2024

I noticed that OpenComputers' manual are written in Markdown format, and docs can be added by external sources like ExtraCells2(see https://github.com/ExtraCells/ExtraCells2/tree/rv6-1.12/src/main/resources/assets/extracells/doc), so it should be possible and easy to add LostUser's README.md to OpenComputers' manual.

By doing so, I can view the docs without the needs of opening a browser page and switching back and forth, definitely will be a smoother gameplay

@Krutoy242
Copy link
Owner

Very nice idea! Thank you for noticing me this. I will think to implement it.

@Krutoy242 Krutoy242 added the enhancement New feature or request label Jul 7, 2024
@Krutoy242
Copy link
Owner

I tried to research where i could find syntax rules for those doc files. If you know, tell me.
Also, this would be hard to implement if OC not support things like tables.

@ZZZank
Copy link
Author

ZZZank commented Oct 15, 2024

OC doc parsing is defined in this package: li.cil.oc.client.renderer.markdown, and you can find all supported markdown syntaxs in its sub-package.

There are two markup formats for OC doc, defined here, but both of them are for Markdown.

A bad news is that, yes, it does not support table, only basic syntaxes can be parsed, some of them are defined here.


Another bad news is that it will be hard support table by ourselves, because there's no commits related to table support for OC, not even after Markdown doc is split into MarkdownManual by some other authors. We have no reference implementation or workaround for it whatsoever

@Krutoy242
Copy link
Owner

Krutoy242 commented Oct 15, 2024

Theoretically, i could "disassemble" table to bullet points, but this would require me to write my own "unparser". And i will need to do the same for many other unsupported formattings.

Considering LostUser is very unpopular, I believe there is no potential users of this ingame gui except you 😁
For you to know - there was no mentions of someone write on LostUser something more complicated than "move 5 times forward, use and go back".

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

No branches or pull requests

2 participants