-
Notifications
You must be signed in to change notification settings - Fork 3
Add cross-reference table for treebase-servlet.xml pages vs documentation #389
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.
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
base: master
Are you sure you want to change the base?
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 ( |
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:
Key undocumented pages include:
/searchForm.html,/searchStudy.html- different URL patterns from documented/search/studySearch.html)/search/downloadAStudy.html,/search/downloadATreeBlock.html, etc.)/user/treeParser.html,/user/treeParserResult.html)/json/submissionIsland.html)/test/testParser.html)Changes Made
doc/PAGE_CROSS_REFERENCE.mdwith comprehensive cross-reference tabledoc/README.mdto link to the new cross-reference documentSource Documents Analyzed
treebase-web/src/main/webapp/WEB-INF/treebase-servlet.xmldoc/v3/user-story-01-search.mddoc/v3/user-story-02-account.mddoc/v3/user-story-03-submission.mddoc/v3/user-story-04-review.mddoc/v3/user-story-05-admin.mddoc/v3/user-story-06-technical.mddoc/v3/user-story-07-governance.mdOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.