Added demo docs and sync workflow

[zoey-kaiser]

WIP

[zoey-kaiser]

This PR currently runs a Github Action called "Sync Docs". What it does it open a PR on https://github.com/sidebase/docs.

It adds:

Files from .docs/content to content/nuxt-session - For the READMEs
Files from .docs/public to public - For any Images used in the docs

Once you merge the new docs in the repestive module repo, you can merge the created PR, to pull the changes onto the Website. We can then add a Action there, to update the website automatically!

Checkout the PR, this PR created: sidebase/docs#2 - Changing anything to the docs in this PR will also update the files in the PR in the docs repo.

Currently todo:

• Get a Personal Access Token for the sideborg account (currently we use my private one, which we do not want to do!)
• Deploy sidebase/docs under the subdomain v2.sidebase.io or another test domain

[BracketJohn]

Thanks!

• Is there a remaining reason for putting the docs into a "secret" .docs folder?
• How can we enable "auto-merge" so that the syncing does not need manual action?
• Are you blocked here by me in any way atm?

[zoey-kaiser]

Is there a remaining reason for putting the docs into a "secret" .docs folder?

I was doing it the way that the docus repo did it: https://github.com/nuxt-themes/docus/tree/dev/.docs
But in the end we can also make it just docs!

How can we enable "auto-merge" so that the syncing does not need manual action?

I was thinking about this. I assume we could enable auto-merge from GitHub. Meaning, if there are no conflicts and the CI passes, it would get merged. I can play with these settings and find a way to get it working!

Are you blocked here by me in any way atm?

I would not say so. I just wanted to ensure you had a look at my PoC. If you are happy with the implementation we can move forward to:

• Getting PRs like this set up in every repo.
• Writing the docs for every repo.
• Deploying a beta on v1.sidebase.io

An issue I am still facing in this repo is this: nuxt-themes/docus#680. The docus team recommended we upgrade the module to Nuxt3 stable. I will add a new PR in nuxt-auth and see if that resolves it, as we already upgraded there!

[BracketJohn]

But in the end we can also make it just docs!

yeah,. let's move to just docs

I was thinking about this. I assume we could enable auto-merge from GitHub. Meaning, if there are no conflicts and the CI passes, it would get merged. I can play with these settings and find a way to get it working!

this is essential, else the whole sync-workflow will not have solved the problem that contributions to docs in repo A need manual steps (that will be forgotten or too tedious for outside / inside collaborators) in order to go-live.

I would not say so. I just wanted to ensure you had a look at my PoC. If you are happy with the implementation we can move forward to:

let's adapt thjis a bit:

1. get auto-sync without human inference to work (remember: this was a requirement I posed to accept this solution)
2. get this pr merged
3. see if the sync workflow works
4. test out npm run build && npm run preview in the docs repo to see that everything works in theory
5. then in parallel:
   • get @DeusAvalon to deploy it into the cluster with CD
   • do the docs PRs on other repos

[BracketJohn]

This PR is a lot bigger than sidebase/nuxt-parse#3 - is this on purpose?

[BracketJohn]

should this go?

[zoey-kaiser]

I wanted to keep these in here to already have the public folder. I was scared that without it people would not know where to put their images for the docs.

[BracketJohn]

missing newline here?

[zoey-kaiser]

I would delete this file anyway, as it was only included in the bootstrapped docus project.

[zoey-kaiser]

This PR is a lot bigger than sidebase/nuxt-parse#3 - is this on purpose?

In the nuxt-parse PR the package.lock.json was missing. Therefore the big difference. As docus is currently not working anyway in these PRs and will need to be refactored, we could either delete the package-lock or ignore it.

[BracketJohn]

Let's ignore and keep it for now, thanks. Please delete the env file so that we can contuinue

[zoey-kaiser]

Let's ignore and keep it for now, thanks. Please delete the env file so that we can contuinue

Deleted!