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

Hosted documentation #69

Open
qunm00 opened this issue May 11, 2024 · 7 comments
Open

Hosted documentation #69

qunm00 opened this issue May 11, 2024 · 7 comments

Comments

@qunm00
Copy link

qunm00 commented May 11, 2024

Currently, documentation is available in the repo, but it's unavailable on the internet. It's difficult for end-user to view the documentation. tangentnotes.com also currently does not have link to documentation.

@qunm00
Copy link
Author

qunm00 commented May 11, 2024

GitHub Pages is a good choice.

@taylorhadden
Copy link
Contributor

Yes, this is an issue that I've been sitting on for a long while. It's good to have it recorded.

GitHub Pages may be a decent stopgap choice, but I would really like to have a set of tools that makes it easy to publish any collection of Tangent-authored notes to the internet via SvelteKit.

@fredguth
Copy link

fredguth commented Dec 5, 2024

GitHub Pages may be a decent stopgap choice, but I would really like to have a set of tools that makes it easy to publish any collection of Tangent-authored notes to the internet via SvelteKit.

How can this be accomplished?
I would like to help with this issue.

@taylorhadden
Copy link
Contributor

It will be a big lift. We'll want to separate out the note display/editing system from tangent-electron and into a module that can be shared. Ideally, we have some common Svelte components and infrastructure (like the workspace) that are used in both places.

I'm currently working on pulling the note parser out. The node editor can be a client of that module.

@taylorhadden
Copy link
Contributor

Separating out the workspace & indexing system would definitely be part of this as well.

@fredguth
Copy link

fredguth commented Dec 6, 2024

One idea is to try to create an app tangent-web and moving everything that is common (workspace, views, etc) to a common place. Maybe in lib?

@taylorhadden
Copy link
Contributor

That's a pretty reasonable starting point. Use "packages" instead though. "Lib" is for semi-external dependencies.

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

No branches or pull requests

3 participants