Api and component documentation

[cyserman]

Add documentation stubs for public APIs and usage, and update README to reflect the current lack of source code.

---

 

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

[gemini-code-assist]

Summary of Changes

Hello @cyserman, I'm Gemini Code Assist¹! 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 establishes the foundational documentation structure for the ProSe project. It introduces placeholder markdown files for public API references and usage instructions, and updates the main README.md to reflect the current state of the repository, which is documentation-only. This prepares the project for future code contributions by providing clear guidelines and templates for how new features and functionalities should be documented.

Highlights

• Documentation Stubs Added: Introduced new documentation files, docs/PUBLIC_API.md and docs/USAGE.md, which serve as stubs and templates for future API references and usage instructions.
• README Update: The README.md file has been updated to include a dedicated 'Documentation' section linking to the new stub files and a 'Status' section clarifying that the repository currently contains only documentation and no source code.
• Future Documentation Structure: The new documentation files lay out a clear structure and templates for how public APIs, functions, components, and usage guides should be documented once source code is introduced to the project.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. ↩

[gemini-code-assist]

Code Review

This pull request does a good job of setting up documentation stubs for the project's public API and usage instructions. The templates are well-structured and will be helpful as the project grows. I've identified a few minor areas for improvement in the documentation text to enhance clarity and correct a typo. My feedback includes suggestions for the README.md and docs/PUBLIC_API.md files.

[gemini-code-assist]

There appear to be a couple of typos in the project description. "Prose'" seems to be a typo for the project name "ProSe", and "litagints" is likely a misspelling. Could you please clarify what was intended? I've suggested a possible correction below.

Suggested change

	the main module for Prose' litagints
	the main module for ProSe agents

[gemini-code-assist]

The title includes "(Auto-generated)", which could be misleading as this file appears to be a manually created template. To avoid potential confusion for future contributors, I recommend removing this part of the title.

Suggested change

	# Public API Documentation (Auto-generated)
	# Public API Documentation

[gemini-code-assist]

The term "Documented commit scope" is not standard and might be confusing. The following line, "Public surface discovered: none", already conveys that there are no APIs yet. To improve clarity, I suggest removing the line about the commit scope.

Suggested change

	- Documented commit scope: `README.md` only
	- Public surface discovered: **none**
	- Public surface discovered: **none**