Skip to content

20240517 Wiki Documentation Spring Cleaning 1530

Erik Nelsestuen edited this page May 24, 2024 · 1 revision

Significant reorganization of Home.md

  • VRO project summary and purpose sections were added to the home page. The content of these sections was largely pulled from documents in VA sharepoint, and edited for relevancy and accuracy.
  • Since Github wikis don't support directories of wiki pages, they are are notoriously impossible to organize from a file system perspective.
  • The home page's primary function is to act as an index for the rest of the wiki. For this index function, additional categorization and groupings of links we added to enhance browsability of the index.
  • Bash scripting was used to ensure that all pages are represented somewhere in the index (previously some pages weren't in the home index).

Removed a large number of RRD pages, removing related links, including but not limited to:

  • References to Apache Camel were removed, including the following:

    • Apache-Camel.md - the page itself and incoming links
    • Code-structure.md - rewrote the section describing how partner applications interact with VRO services, which was the original intent of camel.
  • BIP-Claim-Evidence-API.md and other references to the Claims-Evidence API.

    • The claims evidence API was not ported from RRD and while there was no way to invoke it, there were still docs referencing it. Any documentation that was no longer relevant was removed.
    • BIP-Claims-API.md referenced the evidence api in a number of places and was updated to remove these sections
  • The VRO Console page and related mentions of that RRD platform feature have all been removed.

Other Changes

  • Removed the architecture decisions section of the wiki since it has not been adopted by the team.
  • The GitIgnore file of the repository was updated to allow for the wiki to be hosted as a local obsidian markdown repository.
Clone this wiki locally