Giter VIP home page Giter VIP logo

Comments (6)

lxsmnsyc avatar lxsmnsyc commented on August 30, 2024 2

Thanks for creating this issue!

Yes, definitely. I'm planning on deploying a doc site with interactive playground so that users may try the components while reading the docs. I have done this before so this could be a breeze to implement. Writing the docs, on the other hand, might be a lot of work, although no worries. This should probably come by late October as I have other plans to execute earlier.

I'll keep this issue open for a while to notify about the upcoming docs update.

Edit:
I'm currently exploring Astro's doc template.

from terracotta.

matthiasbaldi avatar matthiasbaldi commented on August 30, 2024 2

For myself, I just took your examples and put them into a (many) multistage Dockerfile to build every example in parallel.
Then I deployed it to fly.io for testing reasons https://solid-headless-demo.fly.dev/
This isn't really beautiful yet but maybe something like that would be enough. Each demo is loaded as an iframe to the single startpage.

If someone want to start it locally (it is just an alpine nginx):

docker pull matthiasbaldi/solid-headless-demo:latest
docker run --rm -p 8080:80 matthiasbaldi/solid-headless-demo:latest

I can make it a bit more beautiful if there is some interest and can also publish it on Github or create an PR for the two additional files I created (Dockerfile & index.html).

from terracotta.

lxsmnsyc avatar lxsmnsyc commented on August 30, 2024 1

Here's a demo badge

Open in CodeSandbox

[![Open in CodeSandbox](https://img.shields.io/badge/Open%20in-CodeSandbox-blue?style=flat-square&logo=codesandbox)](https://codesandbox.io/s/github/LXSMNSYC/solid-headless/tree/main/examples/accordion-example)

from terracotta.

vincentfretin avatar vincentfretin commented on August 30, 2024

@lxsmnsyc How is http://solid-headless.vercel.app maintained? The Modal example there is not the same as in this repo. And the vercel pipeline doesn't seem to work currently on this repo.

I see you added a link to codesandbox https://codesandbox.io/s/github/LXSMNSYC/solid-headless/tree/main/examples/tabs-example/ for the Tabs component in your release notes https://github.com/LXSMNSYC/solid-headless/releases/tag/v0.12.0
Codesandbox is getting the example from github directly? That's nice.
We could add a codesandbox link for each component in the README. What do you think?

from terracotta.

lxsmnsyc avatar lxsmnsyc commented on August 30, 2024

How is http://solid-headless.vercel.app/ maintained? The Modal example there is not the same as in this repo. And the vercel pipeline doesn't seem to work currently on this repo.

The docs site is still experimental. I'm trying to design so that it looks like it has its own UI design but the thing blocking me is how each component is going to be documented (e.g. structure, things that needs to be explained, etc).

I see you added a link to codesandbox https://codesandbox.io/s/github/LXSMNSYC/solid-headless/tree/main/examples/tabs-example/ for the Tabs component in your release notes https://github.com/LXSMNSYC/solid-headless/releases/tag/v0.12.0
Codesandbox is getting the example from github directly? That's nice.
We could add a codesandbox link for each component in the README. What do you think?

Yes we could add codesandbox badges. Weird that I do this in my other repos but not here, but yeah, it's good to be added.

from terracotta.

vincentfretin avatar vincentfretin commented on August 30, 2024

You're talking about codesandbox badge, is this a special button? I'm not used to codesandbox. Do you have an example in another repo? I'm willing to create a PR to add the links.

from terracotta.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.