Structured foundational files for Terra OSS repository

2 min read

📅 2025-04-29 — Session: Structured foundational files for Terra OSS repository

🕒 04:50–05:20
🏷️ Labels: Open-Source, Python, Documentation, Setup.Py, Docusaurus
📂 Project: Dev
⭐ Priority: MEDIUM

Session Goal

The goal of this session was to draft and finalize foundational files for the Terra open-source software repository, ensuring a professional and clean structure for the project.

Key Activities

  • Drafted foundational files: Created essential files such as README.md, LICENSE (MIT), and setup.py to establish a professional structure for the Terra OSS repository.
  • Introductory documentation: Outlined the structure and content for the introductory documentation, including an overview, installation instructions, and running guidelines.
  • Realistic setup.py: Developed a detailed draft of setup.py, outlining its structure, dependencies, and installation instructions for local development.
  • Finalized dependency list: Corrected and finalized the dependency list for setup.py, ensuring all necessary dependencies are included and deprecated practices are avoided.
  • pyproject.toml configuration: Provided a professional-grade pyproject.toml configuration, detailing dependencies and optional development dependencies.
  • Inclusion of non-code folders: Created a MANIFEST.in file to ensure essential non-code folders are included in the package.
  • Documentation management: Planned the migration of documentation to a Docusaurus frontend, ensuring a clean separation of code and documentation.
  • Docusaurus setup checklist: Developed a checklist for setting up a Docusaurus project, including moving documentation, cleaning up the sidebar, and running the project locally.

Achievements

  • Successfully structured the foundational files for the Terra OSS repository.
  • Finalized and corrected the dependency list for the project.
  • Developed a comprehensive plan for documentation management using Docusaurus.

Pending Tasks

  • Complete the migration of documentation to Docusaurus and verify the setup locally.
  • Continue refining the documentation content and structure as needed.

Graph View

Backlinks