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

Confusing Documentation Linking #59

Open
keithrfung opened this issue Sep 11, 2024 · 1 comment
Open

Confusing Documentation Linking #59

keithrfung opened this issue Sep 11, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@keithrfung
Copy link

keithrfung commented Sep 11, 2024

Recreation Steps:

  1. Navigate to 2.0 Specification
  2. Select Guidance & Informative Documents > C2PA Explainer
  3. Use the sidebar to navigate to Technical Specification > Content Credentials
  4. User is now on 1.4 instead of 2.0

This flow I think can easily lead to confusion in the documentation. It's quite easy to navigate and flip through the different versions and many of the versions don't contain the same pages.

The possible fix seems like duplication of those pages within newer versions of the current format of the documentation. This would ensure the user isn't bouncing between versions and allow for updates on newer versions.

@lrosenthol
Copy link
Contributor

I understand the confusion and it is a (reasonable) feature of our publishing system. It uses a backwards compatible versioning scheme, such that newer can refer back to older, but not the other way around (as one would expect).

One thing we are looking at as we move forward is how deprecation of older versions should be reflected, as that would also enable us to make some improvements here as well.

@lrosenthol lrosenthol self-assigned this Sep 11, 2024
@lrosenthol lrosenthol added the documentation Improvements or additions to documentation label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants