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

docs tooling rough edges #448

Open
ms-lolo opened this issue Jan 27, 2025 · 0 comments
Open

docs tooling rough edges #448

ms-lolo opened this issue Jan 27, 2025 · 0 comments

Comments

@ms-lolo
Copy link
Collaborator

ms-lolo commented Jan 27, 2025

a small set of rough edges around the docs tooling that have bitten people during pairing sessions.

  • dev addr port of 8000 does not always work
  • docs folder is expected in component that sets up mkdocs
    • we should be able to ship default docs scaffolding and create the missing directories
  • file watchers do not work for everything
    • can we symlink the other things instead of copying?
    • this might only be the mkdocs.yaml file which is confusing when iterating on settings
  • assuming root readme is index.md does not always work
    • some repos have their own index
    • maybe just do this if there is no index.md in the docs component assets
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

1 participant