search

hylo-lang / hylodoc

Code documentation generator for Hylo
https://hylodoc.web.app
Apache License 2.0
0 stars 0 forks source link

Verify and improve accessibility of the project for new contributors #11

Open ParadoxPixel opened 2 months ago

ParadoxPixel commented 2 months ago

The presence of proper documentation and onboarding for each of the different components (e.g. Swift modules and web design) should be checked to verify if the hylodoc project is accessible to new contributors. This is important for keeping the project maintainable in the long run.

tothambrus11 commented 1 month ago

For context: The fact that we need to check in files generated by vite to the version control is not ideal. One needs to go build the npm project under /web-design, which copies the generated files to the assets directory inside the swift sources. An additional problem with this right now is that the links to assets are not resolved in the same way in the web-design project and in the generated website, and it's easy to make mistakes where it's working in web-design and the asset links are broken on the generated website.