Skip to content

Conversation

d-ronnqvist
Copy link
Contributor

Bug/issue #, if applicable:

Summary

This deprecates and removes hierarchy information from the "linkable-elements.json" file.

This information isn't useful for the purpose of linking to these elements and isn't used anywhere when these elements are linked to.
It could be argued that this information provides a way for tools to read reconstruct the documentation hierarchy. However;

  • it is too limited to accurately represent the documentation hierarchy.
  • this file isn't meant to represent the documentation hierarchy. Clients who need this information should either, read the index/index.json file or pass --enable-experimental-external-link-support and use the information in "link-hierarchy.json" file instead.

Dependencies

None

Testing

Pass the --emit-digest flag to DocC. The created "linkable-elements.json" file shouldn't contain any "taskGroups" information anymore.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added Updated tests
  • Ran the ./bin/test script and it succeeded
  • [ ] Updated documentation if necessary

These link summaries are not meant to represent the documentation hierarchy and this task group information is too limited to work well.
Clients who need this information should get it from the "link-hierarchy.json" file instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant