Added the Documentation for all HTML, js files and README#87
Open
Devayani1612 wants to merge 49 commits intomainfrom
Open
Added the Documentation for all HTML, js files and README#87Devayani1612 wants to merge 49 commits intomainfrom
Devayani1612 wants to merge 49 commits intomainfrom
Conversation
Merge from dev_devayani's branch to dev_luis.
… layout of the page in .html language. Included images to enhance clarity.
Documented all .html files in /web/ using Markdown (.md) files.
Sprint 3 Pull Request
Added docs
…tools-html.md since sandbox.md and tools.md already existed in JS modules according to what I read in my assigned issue.
Updated readme.md
Devayani1612
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds a Docusaurus documentation website to the repository. The main change involves updating the version constraint for @docusaurus/preset-classic from an exact version to a caret range and marking several peer dependencies in the lock file.
Key Changes
- Updated
@docusaurus/preset-classicversion constraint from3.8.1to^3.8.1in bothdocs/package.jsonanddocs/package-lock.json - Added
peer: trueflags to various dependencies in the package-lock.json - Added a complete Docusaurus website scaffold in
docs/my-website/with version 3.9.2
Reviewed Changes
Copilot reviewed 37 out of 75 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/package.json | Changed @docusaurus/preset-classic from exact version to caret range |
| docs/package-lock.json | Added peer dependency flags and updated dependency metadata |
| docs/my-website/package.json | Added new Docusaurus website with version 3.9.2 dependencies |
| docs/my-website/* | Added complete Docusaurus scaffold including config, pages, components, and static assets |
Files not reviewed (1)
- docs/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
17
to
+18
| "@docusaurus/core": "3.8.1", | ||
| "@docusaurus/preset-classic": "3.8.1", | ||
| "@docusaurus/preset-classic": "^3.8.1", |
There was a problem hiding this comment.
Inconsistent version pinning strategy: @docusaurus/core uses an exact version (3.8.1) while @docusaurus/preset-classic uses a caret range (^3.8.1). These packages should typically be kept at the same version to avoid compatibility issues. Consider using the same versioning strategy for both packages, preferably exact versions for better reproducibility.
Comment on lines
+17
to
+18
| "@docusaurus/core": "3.9.2", | ||
| "@docusaurus/preset-classic": "3.9.2", |
There was a problem hiding this comment.
Version mismatch between parent and nested package.json files: The parent docs/package.json uses Docusaurus 3.8.1 while docs/my-website/package.json uses 3.9.2. This creates confusion about which version is actually being used and may lead to dependency conflicts. Consider aligning these versions across both files.
thehabes
requested changes
Nov 1, 2025
Collaborator
thehabes
left a comment
thehabes
left a comment
There was a problem hiding this comment.
There is a lot of work here, a lot of files so I may not have looked as closely at everything as you might like.
The file structure is confusing. You have a /docs directory with a /docs directory in it. It seems like the entire /docs/my-website directory should be removed maybe?
I asked Claude about it and got these notes, which I think should be addressed as part of this PR.
Spelling & Grammar Errors:
-
tools.js(line 86)- Error: "higlighting"
- Should be: "highlighting"
- Comment reads:
* Render tools, higlighting recently used ones.
-
CONTRIBUTING.md(line 24)- Error: "seperate" → should be "separate"
- Error: "requred" → should be "required"
- Error: "extention" → should be "extension"
- Sentence: "The code base is in HTML, CSS, JS so there is no seperate software installation is requred. Just run the code it will open and renders in your default browser. Use the live server extention if needed."
- Grammar: "installation is requred" is awkward; should be "installation required"
-
JSON_Documentation_README.md(line 20)- Error: "more savvier" is grammatically incorrect
- Should be: "savvier" or "more savvy"
- Sentence: "JSON-LD is like a more savvier JSON."
-
about.html(line 45)- Missing quotes: "jobTitle": Software Engineer should be "jobTitle": "Software Engineer"
- This is inconsistent with line 58 which correctly has quotes
File structure concerns
The structure makes sense except:
- my-website should be deleted (it's the default Docusaurus template)
- Docusaurus is being used for developer documentation, which is fine, but it should be properly configured or removed if not actually deployed
Docusaurus Issues
- It's not deployed or linked from the main web application
- The main app in
webis standalone HTML/CSS/JS - Docusaurus appears to be for internal documentation only (explaining the HTML structure)
- The
my-websitesubfolder is completely redundant and should be removed
- Docusaurus configuration problems in
dpcusaurus.config.js- Still references Facebook/Docusaurus placeholder value
organizationName: 'facebook' (line 29) → should be 'oss-slu'projectName: (line 30) → should be 'rerum-playground'editUrl: points to Facebook's repo (lines 51-52, 62-63)- GitHub links in navbar and footer point to 'https://github.com/facebook/docusaurus'
- Footer copyright says "My Project, Inc." instead of the actual project name
- Still references Facebook/Docusaurus placeholder value
- Duplicate/Redundant Structure
- There's a
my-websitefolder that appears to be a duplicate Docusaurus setup - This creates confusion - there are TWO complete Docusaurus sites
docs(the main one being customized)my-website(appears to be the default template, unused)
- There's a
README issues
- Set up instructions saying to right click on
index.htmlare pointing to the root. There is noindex.htmlat the root.
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: '16' | ||
| node-version: '22' |
…ated code into a new folder named "components" with using export/importing functions when necessary and moved playground.js, sandbox.js and tools.js into a new folder named "features".
… request, I integrated some of Joel's architecture such as the generalUtils.js file in web\js\utils folder and objectService.js file in web\js\service folder.
FULL API DOCUMENTATION
- Remove non-existent ./js/index.js reference from index.html - Remove non-existent ./js/about.js reference from about.html - Both files now only include playground.js which handles common functionality This fixes 404 errors that occur when loading these pages.
- Document search scope: body text only - Define search type: plain-text, case-insensitive - Define input format: single string - Define output fields: annotation ID, body text snippet, target URI - Document limitations for Iteration 1 Fixes #113
Removed sections on API methods and examples from the documentation.
ISSUE 114 API DOCUMENTATION
Updated search requirements to reflect changes in matching behavior and API details.
…tation-text-search fixes: #113: define requirements for annotation text search
…logic 115 implement annotation search logic
- Add Search section to sandbox.html (query input, type dropdown, results container) - Wire searchAnnotations() into sandboxUI.js with loading/error/empty/result card states - Add .search-status and .search-result-item styles to sandbox.css - Remove web/search-test.html prototype - Fix broken import paths: playground.js and sandboxUI.js both used ./services/objectService.js instead of ../services/objectService.js, causing silent module load failures - Resolve leftover git merge conflict markers in objectService.js that made the file unparseable and broke the entire module chain Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…into-main-playground-ui fixes issue #124 : Integrate annotation search into Sandbox UI and fix module loading
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.