Add cross-reference table for treebase-servlet.xml pages vs documentation#389
Add cross-reference table for treebase-servlet.xml pages vs documentation#389
Conversation
…tion Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
|
@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.:
And then, specifically, on sections entitled something like |
…down files Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
Updated the cross-reference in commit f192288 to analyze only the v3 user story documents ( Results:
The undocumented pages include RSS feeds, legacy search pages, row segment operations, tree parser functionality, and JSON endpoints. |
|
@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? |
Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
The term "legacy" was misleading. These are alternative URL patterns that exist in the servlet configuration alongside the documented ones. For example:
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. |
|
@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. |
Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
Redid the analysis in commit 6fb4786 with the updated user-story-03-submission.md and user-story-06-technical.md. Updated results:
The updated user stories now include row segment pages ( |
|
@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. |
Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
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:
The unreachable pages are listed in a new "Summary of Unreachable Pages" section. |
|
@copilot I have updated user-story-01-search.md. Please redo the analysis. Keep the overall structure of the report the same. |
Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
Redid the analysis in commit 06efb5c with the updated Updated results:
The updated user story now includes download endpoints: |
|
@copilot I have updated the user stories. Please redo the analysis. Keep the overall structure of the report the same. |
Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
Redid the analysis in commit 09079ca with the updated user stories. Updated results:
Notable changes:
|
Fix Citation published field type mismatch
Fix NumberFormatException when displaying errors/messages in JSP
|
@copilot update this branch from
|
…pilot/crossreference-pages
Co-authored-by: rvosa <106490+rvosa@users.noreply.github.com>
Updated the branch from Results:
As expected, the following pages have been removed from the codebase:
The merge included the deletion of |
Cross-references URL mappings in
treebase-servlet.xmlagainst the "Pages to Account For" sections in the v3 UI/UX user story markdown files (doc/v3/*.md).Summary
Results (after merging from master):
Recent Changes
Updated analysis after merging from master. The following pages have been removed from the codebase:
/test/testParser.html- Development test page (removed)/appletInteraction.html- Applet interaction handler (removed)/user/directToPhyloWidget.html- Direct PhyloWidget link (controller deleted)This reduced the total servlet URL count from 138 to 135, and the unreachable count from 12 to 10.
10 Unreachable pages identified:
/login.html- Alternative to documented/login.jsp/searchForm.html- Alternative search form/searchResult.html- Alternative search results/searchStudyList.html- Study search list/study-query.html- Study query form/search/taxonList.html- Taxon list view/user/authorList.html- Author list/user/displaySubmissionMenu.html- Submission menu display/user/readOnlyListTree.html- Read-only tree list/user/submissionMain.html- Submission main pageChanges Made
doc/PAGE_CROSS_REFERENCE.mdwith comprehensive cross-reference tabledoc/README.mdto link to the new cross-reference documentmasterbranch to incorporate removal of deprecated pagesOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.