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.

Sign up for GitHub

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

Jump to bottom

daft documentation v2 #3621

Open
11 tasks
ccmao1130 opened this issue Dec 19, 2024 · 0 comments
Open
11 tasks

daft documentation v2 #3621

ccmao1130 opened this issue Dec 19, 2024 · 0 comments
Labels
docs enhancement New feature or request

Comments

@ccmao1130
Copy link
Contributor

ccmao1130 commented Dec 19, 2024 •
edited
Loading

Revamping Daft Documentation with MkDocs

Initial PR: #3595

MVP

  • Complete FAQ section on Overview page
  • Delete core_concepts folder if we decide to keep mega core_concepts.md page (or vice versa)
  • Complete all todo(docs)
  • !! Update methods to link to API docs (not URL)

After MVP

  • !! Coming from Spark Guide
  • !! Incorporate Daft Launcher docs
  • Can/Should we combine ^ and distributed computing page?
  • SQL docs, 1-1 mapping to expressions
  • Update wording for Integrations/SQL page (not clear the difference between this and daft-sql)
  • Add more See Also or What's Next across all pages
  • More diagrams in core_concepts.md (and other pages) where applicable (See Integrations/SQL pages as example)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ccmao1130