Skip to content
This repository was archived by the owner on Aug 9, 2024. It is now read-only.

Conversation

@ZakaHaceCosas
Copy link
Contributor

Full documentation for Bussin WebX. It's made in VitePress (with TS and custom CSS enabled).

Content:

  • User manual
  • Developer manual
  • API reference
  • List of available browsers.
  • List of available domain providers.

Everything is up to date for engine version 1.2.2. As new versions release I'll try to keep this up to date.

Notes:

  • A few pages need reviewing (Luau manual needs reviewing at the SET section, Site publishing needs reviewing at the Getting my domain section, and Advanced options needs reviewing at the Using other browsers section).
  • I took the freedom to call our CSS 3 improvement "CSS 3.25", to accompany HTML ++. Take it or leave it.

If any change or update is required just tell me and I'll take care hapily 👍.

@inventionpro
Copy link

Looks good, thing is we already have a gitbook docs page, if anything better updating that than creating another thing to host

@ZakaHaceCosas
Copy link
Contributor Author

The GitBook is not open source I think?

@inventionpro
Copy link

you can ask face to give you access

@ZakaHaceCosas
Copy link
Contributor Author

ZakaHaceCosas commented Jun 4, 2024

That's also an option, I could take care of the docs... but isn't it easier to merge this PR and make the docs open source? It would make it easier to maintain and to keep up to date

@inventionpro
Copy link

good point

@GStudiosX2
Copy link
Contributor

GStudiosX2 commented Jun 4, 2024

Looking through this right now I found one mistake

You cannot embed <style> tags or write inline scripts in your HTML. Due to that, the script tag must be self closing, even thought your IDE might mark that as an error.

so far (thought should be though maybe both make sense though)

@GStudiosX2
Copy link
Contributor

GStudiosX2 commented Jun 4, 2024

Additionally, as of B9 v1.2.2 images are currently broken on Microsoft Windows&tm; and will only work if you follow the Guide of Compilation for Napture - Windows..

Just noticed this said &tm;

@ZakaHaceCosas
Copy link
Contributor Author

Noted. Tomorrow will fix that and give it a full review just in case there are any other typos. Thanks.

@GStudiosX2
Copy link
Contributor

GStudiosX2 commented Jun 4, 2024

You should also note that font-height is actually in pt (you still use px unit though)

@GStudiosX2
Copy link
Contributor

GStudiosX2 commented Jun 4, 2024

Couldn't find any other errors but I mainly just quickly go through it I see you shared some third party browser's maybe can also share some other cool webx projects on a separate page kinda like a awesome list i guess ?

@GStudiosX2
Copy link
Contributor

GStudiosX2 commented Jun 4, 2024

Oh and #121 is merged now so you probably can document more about set_visible (but maybe could wait till it's in a release version) and theres also set_timeout and clear_timeout

@ZakaHaceCosas
Copy link
Contributor Author

Oh and #121 is merged now so you probably can document more about set_visible (but maybe could wait till it's in a release version) and theres also set_timeout and clear_timeout

Sure, I'll take a look at it when I get home.

@face-hh
Copy link
Owner

face-hh commented Jun 5, 2024

Hey!

Thanks for the contribution - docs really needed some polishing.

I've created the docs folder which is synchronised with Gitbook. If you wish you could port your changes there as it also uses Markdown

@ZakaHaceCosas
Copy link
Contributor Author

Thanks! Will start working on that as soon as I get home.

@ZakaHaceCosas
Copy link
Contributor Author

UPDATE

  • Port to GitBook from VitePress done
  • Fixing typos done
  • Updating the Luau reference and finishing it done
  • PLUS Small tweaks and improvments

If any other update is needed just tell me. Now this should be up to date for B9 / Napture 1.2.2. (When there's a new release I'll try to keep the docs up to date ASAP).

@ZakaHaceCosas
Copy link
Contributor Author

(fixed the fact i forgor to remove the old vitepress, lol). now it's fine.

@ZakaHaceCosas
Copy link
Contributor Author

Updated API Reference

@face-hh
Copy link
Owner

face-hh commented Jun 6, 2024

I'll merge this and polish it via Gitbook since it has no way of testing pull requests :^)

@face-hh face-hh merged commit 38992ec into face-hh:master Jun 6, 2024
@GStudiosX2
Copy link
Contributor

I'll merge this and polish it via Gitbook since it has no way of testing pull requests :^)

npm install -g gitbook-cli
gitbook build .
gitbook serve .
I saw somewhere that you can do

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants