Skip to content

v3.2-dev Small post-section-reorg fixes #4913

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: v3.2-dev
Choose a base branch
from
Open

v3.2-dev Small post-section-reorg fixes #4913

wants to merge 5 commits into from
+10 −16

Conversation

handrews
Copy link
Member

This collects several minor adjustments done as individual commits:

  • Merge "Versions" and "Deprecation" into one "Version and Deprecation" section
  • Remove a no-longer-necessary crossreference in the Server Object
  • Rename "Schema" to "Objects and Fields" (and adjust some related text)
  • Add some links to the introductory paragraph to handle the fact that some key concepts are now pushed far down into the Objects and Fields section
  • Get rid of the the hack anchor that already really confused me once by using a different section name and keeping the same behavior as all other sections (please never hack around this again- even though I knew about it I didn't realize that meant the internal links were changed and broke it all more while trying to fix it)
  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

@handrews
Merge Versions and Deprecation sections
14e5667
@handrews
Remove outdated Server Object crossref
2c56b00 
The topic is now in the next section under the Server Object
@handrews
Rename "Schema" to "Objects and Fields"
445d76f
@handrews
Add links to Introduction.
f80a4cd 
This adds some links to key sections that introduce major
concepts that used to be in the introductory sections of the OAS.
It insures that concepts like the difference between serialized
and in-memory data, as well as the multi-document structure of OADs,
are quickly noticed in a top-to-bottom reading (rare as those may be).
@handrews
Remove counter-intuitive section name hack.
2b4c061
@handrews handrews added this to the v3.2.0 milestone Aug 31, 2025
@handrews handrews requested review from a team as code owners August 31, 2025 23:16
@handrews handrews added the editorial Wording and stylistic issues label Aug 31, 2025
@ralfhandl ralfhandl requested a review from a team September 1, 2025 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ralfhandl ralfhandl ralfhandl approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
editorial Wording and stylistic issues
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
2 participants
@handrews @ralfhandl