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

[FEATURE]: Revamp docs and make them more visually appealing #3275

Open
renardeinside opened this issue Nov 14, 2024 · 1 comment
Open

[FEATURE]: Revamp docs and make them more visually appealing #3275

renardeinside opened this issue Nov 14, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@renardeinside
Copy link
Contributor

renardeinside commented Nov 14, 2024

As UCX project grows, a single README.md becomes cluttered and makes a lot of things unclear to the end users.
A proper documentation with appealing visuals would help users to better understand the UCX and apply it.

@renardeinside renardeinside added enhancement New feature or request needs-triage labels Nov 14, 2024
@nfx nfx added documentation Improvements or additions to documentation and removed enhancement New feature or request needs-triage labels Nov 14, 2024
@nfx
Copy link
Collaborator

nfx commented Nov 14, 2024

there's a plan to improve docs, but it's not the highest on the list now. let's use github votes on this issue as a measure of the real customer need - if it reaches

it is wider than just this repository and documentation infrastructure will work with all projects in /databrickslabs org, not just UCX, so docusaurus is not the one high on the list.

we also need docs in the readme as part of the PyPI release, though they still require some post-processing to ToC to render properly, but it'll be done in the same push.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Triage
Development

No branches or pull requests

2 participants