You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
UPDATE 05/27/2024 (transfer issue from in-toto/docs)
Specify how and where developers provide reference docs for new implementations.
Reference documentation should go with the implementation repo in GitHub, with sources and generation information in a doc subdirectory.
Specify what to document for an implementation.
Use the Python Reference Implementation's reference docs to see what needs to be documented.
These are generated using source files and a makefile in the implementation's doc subdirectory.
... with sources and generation information in a doc subdirectory.
There might be programming language-specific best practices for setting up reference documentation.
I think we don't need a policy for where a subproject hosts their docs, but instead recommend that a link to the docs should be included in project wide docs.
UPDATE 05/27/2024 (transfer issue from in-toto/docs)
Reference documentation should go with the implementation repo in GitHub, with sources and generation information in a doc subdirectory.
Use the Python Reference Implementation's reference docs to see what needs to be documented.
These are generated using source files and a makefile in the implementation's doc subdirectory.
The text was updated successfully, but these errors were encountered: