search

openownership / data-standard-sphinx-theme

Documentation theme for the Beneficial Ownership Data Standard.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

README instructions "Follow the instructions in the data-standard README.md." #77

Open odscjames opened 2 years ago

odscjames commented 2 years ago

Put in in https://github.com/openownership/data-standard-sphinx-theme/commit/733f083b91edf5dd32597417589e6495be142fb0

Follow the instructions in the data-standard README.md. This is especially important if you are going to be translating a version of the data-standard's schema.

Can we clarify this a lot, or just remove it? It's not clear at all which instructions we mean to be followed here.

siwhitehouse commented 2 years ago

These refer to the instructions in the README under Technical Documentation. These were three sections:

Dependencies

Do we still want to point people to the instructions to install the dependencies?

Build the docs locally

Instead of referring people back here, that now has instructions on building them from within the data standard repo. From this repo we no longer need people to read this.

Translation

Because of the changes that you have made I don't think that the reference to translation is relevant anymore. We expect people to solely work in the data-standard repo when they are doing translation work now, don't we?

So, I think it is just a question of whether people need to be referred to the dependencies.