Add cross-reference table for treebase-servlet.xml pages vs documentation

[Copilot]

Cross-references URL mappings in treebase-servlet.xml against the "Pages to Account For" sections in the v3 UI/UX user story markdown files (doc/v3/*.md).

Summary

Results:

• Total URL mappings: 138
• Pages accounted for in user stories: 111 (was 109)
• Pages NOT in user stories: 27 (was 29)
  • Reachable from documented pages: 15 (was 13)
  • Unreachable (no links found): 12 (was 16)

Recent Changes

Updated analysis based on changes to all user stories. Notable additions:

• /json/submissionIsland.html now documented in user-story-03-submission.md
• /search/searchResultsAsRDF.rdf now documented in user-story-06-technical.md
• /top/oai now documented in user-story-06-technical.md

12 Unreachable pages identified:

1. /login.html - Alternative to documented /login.jsp
2. /searchForm.html - Alternative search form
3. /searchResult.html - Alternative search results
4. /searchStudyList.html - Study search list
5. /study-query.html - Study query form
6. /search/taxonList.html - Taxon list view
7. /user/authorList.html - Author list
8. /user/displaySubmissionMenu.html - Submission menu display
9. /user/readOnlyListTree.html - Read-only tree list
10. /user/submissionMain.html - Submission main page
11. /test/testParser.html - Development test page
12. /appletInteraction.html - Applet interaction handler

Changes Made

• Updated doc/PAGE_CROSS_REFERENCE.md with revised analysis

Original prompt

Crossreference between the pages listed in https://github.com/TreeBASE/treebase/blob/master/treebase-web/src/main/webapp/WEB-INF/treebase-servlet.xml and those accounted for in the markdown pages referenced in https://github.com/TreeBASE/treebase/tree/v3-ui-ux/doc/v3/README.md

Make a table to report all pages in the treebase-servlet.xml that are NOT in any of the markdown documents.

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[rvosa]

@copilot do NOT scan ALL the markdown documents anywhere in the repository!!!! Only the markdown files that sit within https://github.com/TreeBASE/treebase/tree/v3-ui-ux/doc/v3, i.e.:

• user-story-01-search.md
• user-story-02-account.md
• user-story-03-submission.md
• user-story-04-review.md
• user-story-05-admin.md
• user-story-06-technical.md
• user-story-07-governance.md

And then, specifically, on sections entitled something like Pages to Account For within those markdown documents. What I want is to know if the UI/UX user stories comport with the existing page structure.

[Copilot]

@copilot do NOT scan ALL the markdown documents anywhere in the repository!!!! Only the markdown files that sit within https://github.com/TreeBASE/treebase/tree/v3-ui-ux/doc/v3, i.e.:

• user-story-...

Updated the cross-reference in commit f192288 to analyze only the v3 user story documents (doc/v3/user-story-*.md), specifically their "Pages to Account For" sections.

Results:

• 138 total servlet URLs
• 99 pages covered in user stories
• 40 pages NOT in user stories

The undocumented pages include RSS feeds, legacy search pages, row segment operations, tree parser functionality, and JSON endpoints.

[rvosa]

@copilot What are 'legacy search pages'? How are they legacy with respect to the User Story documentation? Are they simply documented under their JSP extension or something?

[Copilot]

@copilot What are 'legacy search pages'? How are they legacy with respect to the User Story documentation? Are they simply documented under their JSP extension or something?

The term "legacy" was misleading. These are alternative URL patterns that exist in the servlet configuration alongside the documented ones.

For example:

• User Story 01 documents /search/studySearch.html
• The servlet also maps /searchStudy.html to searchStudyController

Both appear to serve search functionality but use different URL patterns. Updated terminology to "Alternative Search URL Patterns" in commit 1f2d196.

Whether these are truly legacy/deprecated or actively used alternatives would require further investigation.

[rvosa]

@copilot I have uploaded user-story-03-submission.md and user-story-06-technical.md. Please redo the analysis. Keep the overall structure of the report the same.

[Copilot]

@copilot I have uploaded user-story-03-submission.md and user-story-06-technical.md. Please redo the analysis. Keep the overall structure of the report the same.

Redid the analysis in commit 6fb4786 with the updated user-story-03-submission.md and user-story-06-technical.md.

Updated results:

• Pages accounted for: 107 (was 99)
• Pages NOT in user stories: 32 (was 40)

The updated user stories now include row segment pages (/user/matrixRowSegmentForm.html, /user/uploadRowSegmentData.html, etc.) and RSS/Atom feeds (/rss.xml, /feed.xml).

[rvosa]

@copilot for those pages that are NOT in user stories, check whether they are reachable from the pages that ARE in the user stories? I.e. do any of the HTMLs that are mapped out in the user journeys link to them? If not, indicate them as (unreachable) in the report.

[Copilot]

@copilot for those pages that are NOT in user stories, check whether they are reachable from the pages that ARE in the user stories? I.e. do any of the HTMLs that are mapped out in the user journeys l...

Added reachability analysis in commit 05879c9.

Searched JSP files, menu configuration, and controller redirects to determine if undocumented pages are linked from documented pages.

Results:

• 14 pages are reachable (linked from menus, JSPs, or controller redirects)
• 18 pages are unreachable (marked as "(unreachable)" in the report)

The unreachable pages are listed in a new "Summary of Unreachable Pages" section.

[rvosa]

@copilot I have updated user-story-01-search.md. Please redo the analysis. Keep the overall structure of the report the same.

[Copilot]

@copilot I have updated user-story-01-search.md. Please redo the analysis. Keep the overall structure of the report the same.

Redid the analysis in commit 06efb5c with the updated user-story-01-search.md.

Updated results:

• Pages accounted for: 109 (was 107)
• Pages NOT in user stories: 29 (was 32)
• Unreachable pages: 16 (was 18)

The updated user story now includes download endpoints: /search/downloadAStudy.html, /search/downloadATreeBlock.html, /search/downloadAnAnalysisStep.html, and /search/downloadANexusRCTFile.html.

[rvosa]

@copilot I have updated the user stories. Please redo the analysis. Keep the overall structure of the report the same.

[Copilot]

@copilot I have updated the user stories. Please redo the analysis. Keep the overall structure of the report the same.

Redid the analysis in commit 09079ca with the updated user stories.

Updated results:

• Pages accounted for: 111 (was 109)
• Pages NOT in user stories: 27 (was 29)
• Unreachable pages: 12 (was 16)

Notable changes:

• /json/submissionIsland.html now documented in user-story-03-submission.md
• /search/searchResultsAsRDF.rdf now documented in user-story-06-technical.md
• /top/oai now documented in user-story-06-technical.md