Skip to content

DocC emits error for topic section missing topic group heading and ignores anonymous curation #404

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

Closed
2 tasks done
ethan-kusters opened this issue Oct 11, 2022 · 1 comment · Fixed by #421
Closed
2 tasks done
Labels
bug Something isn't working

Comments

@ethan-kusters
Copy link
Contributor

ethan-kusters commented Oct 11, 2022

Description

Swift-DocC’s support for anonymous topic sections (#393) doesn’t seem to work for article-only catalogs.

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

I expect to be able to write topic groups with no topic headings in an article-only catalog that uses @TechnologyRoot.

Actual behavior

I see the following warnings:

/Users/ekusters/Downloads/AnonymousTopicTest.docc/Article1.md:5:1: warning: Missing required subheading for Topics section.
A Topics section requires at least one topic, represented by a level-3 subheading. A Topics section without topics won’t render any content.”
/Users/ekusters/Downloads/AnonymousTopicTest.docc/Test.md:7:1: warning: Missing required subheading for Topics section.
A Topics section requires at least one topic, represented by a level-3 subheading. A Topics section without topics won’t render any content.”

And the built Archive does not include my curations.

Steps To Reproduce

  1. Open the attached DocC catalog

  2. docc preview

Swift-DocC Version Information

61100a4

Related Issues

  • rdar://100994549
@ethan-kusters ethan-kusters added the bug Something isn't working label Oct 11, 2022
@dobromir-hristov
Copy link
Contributor

Noticed this one today while trying to remove groupMarkers from the navigator. Removed the H3 under Topics and It removed all those items from the page Topics and from the Nav hierarchy as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants