chalkboard.js.org

[QwertyIsCoding]

• There is reasonable content on the page (see: No Content)
• I have read and accepted the Terms and Conditions
• The site content can be seen at https://qwertyiscoding.github.io/Chalkboard or https://chalkboard-docs.pages.dev

The site content is documentation for my JS framework - Chalkboard. It is a cloud based note taking system powered by Firebase to simplify tasks such as feedback /contact forms, and any persistent user-noted data on a static website.

I plan to host it on GitHub pages with the js.org domain, but the .pages.dev is a placeholder for now hosted on Cloudflare Pages.

[MattIPv4]

I'm reading through your content, and I'm really struggling to understand how another JavaScript developer is meant to use this. The content seems to just be documentation of the source code you've written, not a guide on how to actually use this framework for their own project?

[QwertyIsCoding]

It's built as a framework - as a large example project for someone to integrate the said features into their software. The project is under active development, and soon will have a script they can link to their site to add the functions mentioned, and more.

And you're 100% correct on how it is confusing for the developer to figure out what to do moving forward (that's what the implementation page tried to do), but that's since I am assuming a few gaps that aren't covered fully in the documentation.

Do I make another PR once the documentation is complete?

The project is under active development (both documentation and the project itself) -> hence this confusion. Sorry about that!

[indus]

@QwertyIsCoding We don’t provide subdomains for example projects or tutorial-style content. The project should offer something that JavaScript developers can actually use. Based on the information in the submission.md in the repo, it appears that much of the code was generated by AI. I’m not inclined to add AI-generated tutorials, and developers should then learn from it or integrate by copying features over. Thant sounds not reasonable to me.

[QwertyIsCoding]

Understood -- and it was (as mentioned in the README and info page of the website), because it was built for a GitHub Copilot challenge where the premise was to use AI to build an app in one day. I am just adding on to that application now by making it into a framework.

Unless I have misunderstood the requirements to be a JS library.

I apologize for the inconvenience caused.

[indus]

No problem. There are a variety of similar services that may fit better.