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

Add documentation on website #18

Closed
mjovanc opened this issue Dec 20, 2024 · 2 comments
Closed

Add documentation on website #18

mjovanc opened this issue Dec 20, 2024 · 2 comments
Labels
feature New feature or request

Comments

@mjovanc
Copy link
Member

mjovanc commented Dec 20, 2024

I think we should move the documentation from the Delta wiki to Delta website. This is the current Wiki: https://github.com/delta-rs/delta/wiki

My idea is that we move it there somehow. Also we need documentation for the Nebula project how to use it etc. It can be TBD there for now, but just so we have a place to add that documentation.

I would like that in this repo we could write the documentation in Markdown if possible.

I'm checking Tensorflows docs and it looks like this: https://www.tensorflow.org/tutorials which looks cool. And if we could Organize it somehow like this (not strict):

Delta

  • Beginner
    -- Some Topic
    -- Some Other Topic
  • Advanced
    -- Some Topic
    -- Some Other Topic

Nebula

  • Beginner
    -- Some Topic
    -- Some Other Topic
  • Advanced
    -- Some Topic
    -- Some Other Topic

We have two seperate projects on-going so it would be good to seperate them I believe like this.

What do you think of this @SvMak?

@mjovanc mjovanc added the feature New feature or request label Dec 20, 2024
@mjovanc
Copy link
Member Author

mjovanc commented Dec 20, 2024

We should probably have on the landing page under the three boxes this information (will be added more later): https://github.com/delta-rs/delta/wiki/Getting-Started

@mjovanc mjovanc mentioned this issue Dec 20, 2024
@SvMak SvMak mentioned this issue Dec 26, 2024
@SvMak
Copy link
Member

SvMak commented Dec 27, 2024

If you feel the issue is not resolved, please reopen it.

@SvMak SvMak closed this as completed Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants