Restructure#9
Draft
danielgamage wants to merge 5 commits into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
This pull request restructures the documentation site for the
data-latheproject, moving the docs out of thedocs/directory to the repository root and updating related configuration and documentation. It also improves the developer experience for contributing and building both the library and the docs site. The most important changes are:Docs Site Restructure and Cleanup
Moved the documentation site from the
docs/directory to the root-levelsite/, renaming and relocating files such asindex.htmland source files, and updating references accordingly. Removed now-unnecessary files includingdocs/package.json,docs/tsconfig.json,docs/vite.config.ts,docs/.gitignore, anddocs/README.md. [1] [2] [3] [4] [5] [6]Updated
.npmignoreto exclude the new docs site structure (site/,public/, etc.) and include only the necessary files for publishing the package.Developer and Contributor Experience
Added a comprehensive
CONTRIBUTING.mdwith clear guidelines and checklists for adding new functions, updating documentation, and writing tests, making it easier for new contributors to participate.Updated
README.mdto include instructions for developing the docs site locally, clarifying the relationship between the library and the documentation.Build and CI Improvements
npm run test:ciinstead ofnpm testfor CI, ensuring the correct test command is used.Miscellaneous
Improved code organization in
index.jsby grouping related functions under clearer section comments and moving function definitions for better readability. [1] [2] [3] [4] [5]Updated ESLint configuration to target the new
site/directory instead ofdocs/.These changes modernize the project structure, clarify contribution and development processes, and streamline the build and publishing workflow.