Skip to content

Minor fixes in docs#283

Merged
nk-ag merged 3 commits intoexospherehost:mainfrom
nk-ag:pathofdocs
Aug 24, 2025
Merged

Minor fixes in docs#283
nk-ag merged 3 commits intoexospherehost:mainfrom
nk-ag:pathofdocs

Conversation

@nk-ag
Copy link
Contributor

@nk-ag nk-ag commented Aug 24, 2025

No description provided.

nk-ag added 3 commits August 24, 2025 22:02
- Added a new section on Open Source Commitment in README.md, outlining our dedication to the open source community.
- Updated navigation in mkdocs.yml to reflect changes in documentation structure.
- Expanded the Getting Started guide with detailed installation instructions, environment setup, and an overview of core concepts.
- Introduced new logo assets for branding consistency.
- Removed outdated files and streamlined content for clarity and better user experience.

This update aims to improve accessibility and understanding of the Exosphere platform for new users and contributors.
- Updated README.md to center-align badge links for better presentation.
- Removed the "Star History" section from both README.md and index.md to streamline content.
- Simplified logo display in index.md by removing unnecessary HTML structure.

These changes enhance the overall readability and user experience of the documentation.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 24, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added an Open Source Commitment section outlining principles and contact details.
    • Introduced comprehensive runnable examples (HelloWorldNode, DataProcessorNode) with inputs/outputs/secrets, execute methods, and runtime start guidance.
    • Expanded guidance on running, checking, and using the interactive dashboard.
    • Reformatted badges in the README for a centered, cleaner presentation.
    • Removed the centered logo header from docs landing page.
    • Removed the Star History section from README and docs.
    • Minor wording and structural improvements across documentation.

Walkthrough

Documentation-only updates: README badges switched to centered HTML, an Open Source Commitment section added (with a duplicated header/content), and Star History removed. In docs index, header logo HTML removed, extensive Node examples and guidance added, a duplicated informational line inserted, and Star History removed.

Changes

Cohort / File(s) Summary of changes
README presentation and sections
README.md
Replaced markdown badges with centered HTML badge block; inserted an Open Source Commitment section (resulting in duplicate header/content); removed Star History section; minor wording/structure tweaks.
Docs index content updates
docs/docs/index.md
Removed centered logo HTML header; added detailed Node examples (HelloWorldNode, DataProcessorNode) with runtime usage; added run/check/dashboard guidance; duplicated the sentence “The runtime will automatically reload and register the updated node.”; removed Star History section.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I thump my paws on docs so bright,
Badges dance in centered light.
Stars have set, examples rise,
Nodes now hum with crisp replies.
Open hearts, open source we share—
A carrot toast to code laid bare! 🥕✨


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 6e22a24 and c3246da.

📒 Files selected for processing (2)
  • README.md (2 hunks)
  • docs/docs/index.md (1 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @nk-ag, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on minor fixes and significant enhancements to the project's documentation. It updates the main README.md file with improved badge formatting and a detailed open-source commitment statement. Additionally, it greatly expands the docs/docs/index.md with comprehensive examples and instructions for getting started with Exosphere nodes, while also removing redundant 'Star History' sections from both documentation files.

Highlights

  • Improved Badge Presentation: The project badges in README.md have been refactored to be centrally aligned and now include alt attributes, enhancing visual presentation and accessibility.
  • New Open Source Commitment Section: A new, comprehensive section detailing the project's commitment to open source has been added to README.md, outlining contributions, profit donation, and collaboration with student programs.
  • Removal of Star History Chart: The 'Star History' chart section has been removed from both README.md and docs/docs/index.md.
  • Enhanced Documentation Examples: Significant new content has been added to docs/docs/index.md, including step-by-step guides and code examples for creating, running, and interacting with Exosphere nodes, such as 'Hello World' and 'Data Processor' examples.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@nk-ag nk-ag merged commit 293ea82 into exospherehost:main Aug 24, 2025
3 of 4 checks passed
@gemini-code-assist
Copy link
Contributor

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

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.

1 participant