Skip to content

REF-14: Convert Word documentation to Markdown and merge into README - #88

Open
thomasnymand wants to merge 1 commit into
masterfrom
feature/REF-14-word-docs-to-markdown
Open

REF-14: Convert Word documentation to Markdown and merge into README#88
thomasnymand wants to merge 1 commit into
masterfrom
feature/REF-14-word-docs-to-markdown

Conversation

@thomasnymand

Copy link
Copy Markdown
Collaborator

Converts doc/Using OIOSAML for Java.docx to Markdown and merges it with the existing README.md into a single comprehensive guide.

Changes

  • Fenced code blocks with language tags for all XML/Java/properties/bash snippets (previously escaped inline text from the Word export).
  • Native Markdown tables for the DispatcherServlet / AuthenticatedFilter / AppSwitch configuration parameters.
  • Anchor-based table of contents and working intra-document cross-references.
  • Extracted the embedded image to doc/assets/demo-application.png.
  • Preserved the existing README content (version mapping, release-notes link, Windows SSL trust setup, integration-test instructions).
  • Removed the now-redundant Word document.

Corrections against current source

While converting, the content was cross-checked against the code:

  • Refreshed the demo module file tree (no config/ dir; keystore.p12 under resources/; added appswitch/ and test-devtest4-idp-metadata.xml).
  • Bumped documented release/dependency versions to 3.2.2.
  • Made the SameSite filter value explicit (None, per SameSiteFilter).
  • Restored the throws clauses on the SessionHandlerFactory interface snippet.

Note: the documentation review also uncovered a code bug in the default audit-attribute mapping, fixed separately in REF-15.

🤖 Generated with Claude Code

Convert 'doc/Using OIOSAML for Java.docx' to Markdown and merge it with the
existing README.md into a single comprehensive guide:

- Fenced code blocks with language tags for all XML/Java/properties/bash
  snippets (previously escaped inline text).
- Native Markdown tables for the DispatcherServlet/AuthenticatedFilter/
  AppSwitch configuration parameters.
- Anchor-based table of contents and working intra-document cross-references.
- Extracted the embedded image to doc/assets/demo-application.png.
- Preserved the existing README content (version mapping, release notes link,
  Windows SSL trust setup, integration test instructions).
- Corrected content against the current source: refreshed the demo module
  file tree, bumped the documented release/dependency versions to 3.2.2, made
  the SameSite filter value (None) explicit, and restored the SessionHandler-
  Factory interface throws clauses.

Remove the now-redundant Word document.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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