beeware / batavia

A JavaScript implementation of the Python virtual machine.
http://pybee.org/batavia
Other
1.39k stars 424 forks source link

The links to contributor's guide and others appear to be broken #828

Open pranavmodx opened 5 years ago

pranavmodx commented 5 years ago

3 of the links given in the the section : 'docs/how-to/contribute-code.rst' appear to be broken. I could help fix this by replacing them with the correct links if someone could point me to where they are obtained from.

freakboy3742 commented 5 years ago

Thanks for the report! These links obviously got broken during a recent docs refactor.

The correct destinations should be:

For bonus points; adding a build test that validates that documentation is accurate would be extremely helpful.

pranavmodx commented 5 years ago

I have updated the links to correct destinations. I looked at the test sections but can't seem to figure out a way for adding a build test or how it works. Could you please guide me through it?

freakboy3742 commented 5 years ago

So - Adding a build test would mean adding a CI stage that does a build of the documentation to confirm that there are no errors. We're in the process of moving all our CI to Github Actions; if you wanted to try adding a Github actions configuration for Batavia, replacing the current BeeKeeper configuration, but adding a documentation step, that would be really helpful.

As a point of reference, Briefcase has a Github Actions configuration in it's v0.3 branch