Skip to content

Improve Project File Organization and Documentation#5

Merged
Data-Science-Link merged 1 commit into
mainfrom
project-reorganization-prep-9743092125086959634
Jun 27, 2026
Merged

Improve Project File Organization and Documentation#5
Data-Science-Link merged 1 commit into
mainfrom
project-reorganization-prep-9743092125086959634

Conversation

@Data-Science-Link

Copy link
Copy Markdown
Owner

I have completed the task of improving the project file organization and documentation to prepare for the actual development phase.

Here's a summary of the actions taken:

  1. Directory Restructuring:
    • Renamed the documentation folder to project_documentation.
    • Renamed data_engineering to pipeline to better reflect its role in the new architecture.
    • Removed the obsolete data_final directory.
    • Created pipeline/data, public, and src directories to separate concerns between the data pipeline and the web frontend.
  2. Dependency & Configuration Updates:
    • Updated pyproject.toml with the core libraries needed for the project: atproto (Bluesky), pandas, bertopic (clustering), and ollama (local LLM).
    • Initialized a package.json with Vite, React, Three.js, and React Three Fiber.
    • Configured Tailwind CSS and PostCSS for the frontend.
  3. Documentation Improvements:
    • Updated README.md with new installation instructions and an overview of the revised structure.
    • Updated FILES.md to provide an accurate map of the repository.
  4. Infrastructure & Security:
    • Updated scripts/security_check.sh and the GitHub security audit workflow to point to the new pipeline directory.
    • Verified the environment by running the local security scan.
  5. Boilerplate Creation:
    • Created a skeleton pipeline/run_pipeline.py and a sample public/data.json to define the data interface.
    • Set up a basic React app entry point in src/ to facilitate immediate frontend development.

The project is now "John the Baptist" ready for the main development to begin.

Fixes #4


PR created automatically by Jules for task 9743092125086959634 started by @Data-Science-Link

This commit reorganizes the project structure and documentation to align with the proposed architecture for Perspectiverse.

Key changes:
- Renamed 'documentation' to 'project_documentation'.
- Refactored 'data_engineering' to 'pipeline' and updated its structure.
- Established a React + Three.js frontend scaffolding in 'src' and 'public'.
- Updated 'pyproject.toml' with context-relevant dependencies (atproto, bertopic, ollama, pandas).
- Updated project documentation (README.md, FILES.md) to reflect the new structure.
- Adjusted security scripts and CI/CD workflows for the new directory layout.
- Added essential configuration files for Vite and Tailwind CSS.

Co-authored-by: Data-Science-Link <61164085+Data-Science-Link@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions

Copy link
Copy Markdown

🔒 Security Scan Complete

Code Security (Bandit): ✅ No high/medium severity issues found.
Dependencies (pip-audit): ✅ No vulnerable dependencies found.

All security checks passed!

@Data-Science-Link Data-Science-Link merged commit 20922e9 into main Jun 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Project File Organization and Documentation

1 participant