Align documentation with latest StructSense updates

[tekrajchhetri]

This pull request updates the documentation to reflect recent changes made to StructSense.

[gemini-code-assist]

Summary of Changes

Hello @tekrajchhetri, 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 updates the documentation for StructSense to align with recent application changes. The updates include a reorganization of the navigation structure, clearer explanations for configuration variables, an expanded troubleshooting section with new FAQs, and revised examples and deployment instructions. The goal is to provide more accurate and user-friendly documentation for developers and users.

Highlights

• Documentation Structure Refined: The table of contents (_toc.yml) was reorganized, moving deployment documentation and adding a new UI developer document, streamlining navigation.
• StructSense Configuration Clarified: Updated descriptions for runtime variables, added details on experiment tracking, and corrected example configuration filenames for better clarity.
• Examples and Tutorials Enhanced: The examples section was renamed to "Tutorials & Examples" and updated to better guide users on available resources and templates.
• Installation Guidance Improved: A note was added to the getting started guide recommending GitHub installation for the latest StructSense updates, ensuring users access the most current version.
• Troubleshooting Expanded: Several new frequently asked questions were added to address common issues related to tracing, agent memory, chunk sizes, and developer documentation.
• New UI Developer Document: A dedicated document for UI developer information was introduced to provide specific guidance.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• docs/_toc.yml
  • Reorganized the navigation structure by moving deployment_braikbservices under "Ingestion Service" and deployment_userinterface and ui_developer_document under "BrainKB User Interface".
  • Removed the top-level "Deployment" caption.
• docs/deployment_braikbservices.md
  • Updated the main heading from "Deployment of BrainKB Services" to "Deployment".
• docs/deployment_userinterface.md
  • Updated the main heading from "Deployment of User Interface" to "Deployment".
• docs/structsense_configuration.md
  • Revised the explanation for runtime variables, clarifying dynamic population and input map matching.
  • Corrected an example configuration filename from ner_config_gpt.yaml to ner-config.yaml.
  • Updated the description example for task inputs from {literature} to {input_text}.
  • Added new sections for "Experiment Tracking (optional)" and "Minimal (no tracking, no knowledge source)" environment variables.
  • Removed redundant "Experiment Tracking" and "Minimal" sections from the end of the file.
  • Expanded the description of available templates in config_template/.
• docs/structsense_examples.md
  • Renamed the document title from "Examples" to "Tutorials & Examples".
  • Updated references for usage demonstrations from example/ to tutorial/ directory.
  • Clarified the contents of the config_template/ directory.
  • Removed the "Example Use Cases" section.
  • Updated the reference for environment variables to .env_example.
• docs/structsense_getting_started.md
  • Added a note advising users to install from GitHub for the latest updates.
  • Modified the description of Grobid usage to state that StructSense "uses" Grobid instead of "by default, uses" Grobid.
• docs/structsense_troubleshooting.md
  • Added new FAQ entries addressing execution tracing, agent memory errors, chunk size impact, and developer documentation location.
  • Removed the FAQ about Weaviate necessity.
• docs/ui_developer_document.md
  • Added a new file titled "Developer Documentation".

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 updates the documentation to align with recent changes in StructSense. The changes include reorganizing the table of contents, updating configuration details and examples, and adding new troubleshooting information. My review focuses on improving the clarity and consistency of the documentation. I've suggested making some titles more specific, clarifying potentially confusing sections, and fixing minor grammatical and formatting issues. Overall, the updates are a good step towards keeping the documentation current.

[gemini-code-assist]

To improve clarity, consider making the title more specific, as this file is now part of the 'BrainKB User Interface' section in the table of contents. A more descriptive title would help readers understand the context better.

Suggested change

	# Deployment
	# User Interface Deployment

[gemini-code-assist]

The ## Legacy heading here might cause confusion. It implies that using a 'Knowledge Source (Vector DB)' is a legacy feature, yet the ## Environment Variables section below provides detailed current configuration for Weaviate (a vector DB). To avoid ambiguity, please clarify if using a vector DB is a legacy approach. If so, consider moving all Weaviate-related environment variable documentation under this Legacy section.