Commit graph

214 commits

Author SHA1 Message Date
DESKTOP-RTLN3BA\$punk
4a05a114ab chore: plain Apache LICENSE, and the site and README say the plugins have shipped
- LICENSE is the plain Apache 2.0 text, without the "Portions of this
  software" preamble, so GitHub's About panel names the license. The two BSL
  folders keep their own LICENSE, which names each folder as its scope; the
  README's License section and the Terms page now name both, and the Terms
  point at the LICENSE files rather than the root one alone.
- /plugins: the eight plugins shipped in 2.2.1, with what each reads, how to
  start (download, free 30-day licence, Settings › Plugins, @ in a chat),
  third-party plugins and the registry, and why Reddit and Instagram are not
  offered.
- /pricing: 7 platforms and the web crawler, not 9; the plugin note, the
  licence and trial answers and the expiry answer describe the shipped
  plugins; third-party plugins need no licence.
- Homepage plugin band: no longer "Coming soon".
- README: a Plugins section linking /downloads for the free licence, in place
  of Star history.
2026-10-15 14:49:37 -07:00
DESKTOP-RTLN3BA\$punk
4dd3ce2f66 docs: cover the work since 2.1.0 so others can pick it up
- chat.md, overview.md: how a streamed token renders only the live reply
  (runSummaries, the 32 ms notice gap, LiveThreadRuntime, the bounded
  highlighter, memoized panels) and that the columns resize.
- model-capabilities.md, agent.md, data-model.md, 07-dev-setup.md: the two
  chat modes, their gates and defaults, where a pick is stored, the 0-id fix,
  and how to re-run the OpenRouter sweep and regenerate capabilities.json.
- RELEASE.md: the steps 2.2.0 was released by, from the bump (with its
  PowerShell form) to the tag on the merge, the Known issues, an optional
  update check and publishing with --latest; dry runs are signed.
- 06-repo-readme.md, AGENTS.md, README.md's comment: the README's structure,
  how to change it and its translations, re-checking the format table, and
  replacing the demo video.
- Stale statements fixed (the Apple agreement, opencode never shipped, three
  languages, Studio's exec(), proposal statuses, the roadmap), and each gap
  still open after the release in its doc's Known gaps, linked to #2219-#2230.
2026-10-11 17:55:51 -07:00
DESKTOP-RTLN3BA\$punk
25db53c2b6 docs(readme): fix the English slips and the stale maintainer notes
Capitalise NotebookLM, hyphenate privacy-focused, end the licence line with a
full stop and put a blank line before Quick start. The top comment drops the
Quick start image notes, since those images are gone, and says every
README.<locale>.md follows this file section for section.
2026-10-09 13:52:44 -07:00
DESKTOP-RTLN3BA\$punk
3f8381728a docs(readme): remove self-hosting note from README 2026-10-09 13:38:12 -07:00
DESKTOP-RTLN3BA\$punk
83b3aaa5e4 docs(readme): updated readme 2026-10-09 13:37:01 -07:00
DESKTOP-RTLN3BA\$punk
2ccb2af69d docs(readme): show the contract redline demo under the header
The hero GIF placeholder becomes the recorded demo: the agent revises a city
contract as a copy, with tracked changes and a comment on each change. The
video is a GitHub upload that plays inline; the top comment says how to
replace it.
2026-10-09 13:25:44 -07:00
DESKTOP-RTLN3BA\$punk
7453104b22 docs(readme): lead with what the agent does to each format, add a Quick start
The README is shorter and leads with a table of the file formats SurfSense
reads, makes, edits as a copy and transforms. A five-step Quick start, from
install to a cited answer and a Word file from Studio, replaces the old one.
Private by default and Models are gone; Star history stays.

Only the English README changes. The translations still follow the old layout.
The hero GIF and the five Quick start images are still to record; a comment
above each one says what to show.
2026-10-08 17:36:49 -07:00
Anish Sarkar
1445f51fd9 docs(readme): lead every README with the SurfSense banner
Swap the 128px icon for homepage/banner.png at the top of README.md and
all ten translated READMEs, keeping each locale's alt text.
2026-09-28 20:07:49 +05:30
Anish Sarkar
7381258aa1 docs(readme): swap the hero screenshot for desktop.png
Point every README translation and the SEO planning docs at the new
desktop screenshot. It still shows Studio open with Qwen selected, so
the alt text stays as it was. Remove the now-unused offline-studio.png
and comments-audio.webp.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-28 12:29:57 +05:30
CREDO23
056e682fbc docs(local): document podcasts on audio.cpp
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-24 15:18:59 +02:00
DESKTOP-RTLN3BA\$punk
2cb3510f9b docs: update AGENTS.md and README files with new language links and sunset details
- Clarified the status of the hosted service in AGENTS.md, including data purge dates.
- Updated language links in README files to include additional languages: Arabic, German, French, Japanese, Korean, and Russian.
- Adjusted README comments regarding sunset callout consistency across localized versions.
2026-09-22 22:08:49 -07:00
DESKTOP-RTLN3BA\$punk
35839cf9ff docs(readme): add a contributing section and drop the expired project board. 2026-09-22 21:34:36 -07:00
DESKTOP-RTLN3BA\$punk
70864e38f3 docs: rewrite translated READMEs for 2.0.0 and restore the language row
README.es.md, README.pt-BR.md, README.hi.md and README.zh-CN.md all
still described the retired hosted product, which is why the language
switcher was commented out. Each is now a translation of the current
root README, tracking it section for section: same headings, table
shapes, bullet counts and images, with the in-page nav anchors
repointed at the translated headings.

The root README gains the per-platform download table on the
unversioned permalinks, and its Quick start step 1 stops repeating the
same link. AGENTS.md said not to edit the root README; the draft it
pointed at shipped on 18 Sep and says to edit the root file directly.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-21 13:46:15 -07:00
CREDO23
3cbc0564e4 docs: restore the Trendshift badge on the README 2026-09-18 09:08:51 +02:00
CREDO23
bbf995931f docs: ship the 2.0 README for the local desktop app
The live page still described the hosted open-web product. Point it at the air-gapped app, the Studio still, and the 18 October export deadline.
2026-09-18 08:44:12 +02:00
DESKTOP-RTLN3BA\$punk
49149ece1d feat(local): more pre release tweaks 2026-09-17 21:19:21 -07:00
Anish Sarkar
5d052831f7 docs(artifacts): document removal of document exports 2026-08-16 20:51:28 +05:30
DESKTOP-RTLN3BA\$punk
847b3a3a27 feat(docs): update README files to include Walmart as a data source for all language versions 2026-07-25 15:58:46 -07:00
CREDO23
91aa265afb Merge remote-tracking branch 'upstream/dev' into feature-indeed-jobs-scraper
# Conflicts:
#	README.es.md
#	README.hi.md
#	README.md
#	README.pt-BR.md
#	README.zh-CN.md
#	surfsense_backend/tests/unit/capabilities/google_maps/test_registry.py
#	surfsense_backend/tests/unit/capabilities/reddit/test_registry.py
#	surfsense_backend/tests/unit/capabilities/youtube/test_registry.py
#	surfsense_mcp/mcp_server/features/scrapers/__init__.py
#	surfsense_web/content/docs/connectors/index.mdx
#	surfsense_web/content/docs/connectors/native/index.mdx
#	surfsense_web/content/docs/connectors/native/meta.json
#	surfsense_web/content/docs/how-to/mcp-server.mdx
#	surfsense_web/lib/connectors-marketing/index.ts
#	surfsense_web/lib/playground/catalog.ts
2026-07-18 22:11:30 +02:00
DESKTOP-RTLN3BA\$punk
1dc69cdfb3 refactor: update branding and descriptions across documentation and components to emphasize SurfSense as the open-source NotebookLM alternative for web research 2026-07-17 17:18:11 -07:00
DESKTOP-RTLN3BA\$punk
bd7647b314 refactor: update README files and system prompts to include Amazon as a data source for AI agents, enhancing the platform's capabilities for live web research 2026-07-17 16:44:11 -07:00
DESKTOP-RTLN3BA\$punk
065020c814 refactor: update community references in README files and connector to reflect transition from 'webscraping' to 'SaaS'
Some checks are pending
Build and Push Docker Images / finalize_release (push) Blocked by required conditions
Build and Push Docker Images / compute_version (push) Waiting to run
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, , production, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, , production, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda126, production, true, cuda126) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda126, production, true, cuda126) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda, production, true, cuda) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda, production, true, cuda) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-24.04-arm, linux/arm64, arm64, , runner, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-latest, linux/amd64, amd64, , runner, false, cpu) (push) Blocked by required conditions
Build and Push Docker Images / verify_digests (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (backend, surfsense-backend, , cpu) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda, cuda) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda126, cuda126) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (web, surfsense-web, , cpu) (push) Blocked by required conditions
2026-07-16 20:27:23 -07:00
DESKTOP-RTLN3BA\$punk
a7903e0b4b refactor: update README files to reflect the transition of SurfSense to an open web research platform for AI agents 2026-07-16 18:52:00 -07:00
CREDO23
e19c876fbc feat: wire indeed connector into env, readmes, playground and marketing 2026-07-15 19:03:51 +02:00
DESKTOP-RTLN3BA\$punk
1bc7d9f51c Update README files in multiple languages to include Instagram and TikTok as new data sources for live scraping, enhancing the platform's competitive intelligence capabilities. 2026-07-13 15:03:24 -07:00
DESKTOP-RTLN3BA\$punk
f70b83582f Update README files in multiple languages to reflect the rebranding of SurfSense as NotebookLM for competitive intelligence research, emphasizing live scraping capabilities and clarifying the platform's features. 2026-07-13 14:18:15 -07:00
CREDO23
6da1dd8f86 docs(mcp): document hosted /mcp remote endpoint 2026-07-07 18:27:19 +02:00
DESKTOP-RTLN3BA\$punk
64f2b4a6eb feat: updated readmes 2026-07-06 16:57:04 -07:00
DESKTOP-RTLN3BA\$punk
50f2d095aa feat: api playground, other tweaks 2026-07-06 16:45:04 -07:00
DESKTOP-RTLN3BA\$punk
af7cdd3ca5 fix: update README files to correct image references and remove unnecessary elements
- Fixed image references in multiple language README files to ensure proper display.
- Removed unnecessary HTML elements for a cleaner presentation.
2026-07-05 21:27:27 -07:00
DESKTOP-RTLN3BA\$punk
93bec4a38e feat: announcements and readme rework 2026-07-05 21:23:25 -07:00
DESKTOP-RTLN3BA\$punk
cfa52929cc fix(docs): add missing line breaks in README files
- Added line breaks in the automations section across multiple language README files for improved readability and formatting consistency.
2026-05-31 19:29:36 -07:00
DESKTOP-RTLN3BA\$punk
0ae30839aa feat(docs): add AI automations and agents section to README files
- Introduced a new feature highlighting AI automations and agents across multiple language README files.
- Described capabilities for scheduling AI workflows and event-triggered actions, enhancing user understanding of automation functionalities.
- Updated feature comparison tables to include AI automations, providing a clearer overview of available features.
2026-05-31 18:36:57 -07:00
DESKTOP-RTLN3BA\$punk
414ca67872 feat(docs): update README files with enhanced prompts
- Revised the AI Resume Builder description to emphasize tailoring resumes for job descriptions and ATS compliance.
- Added example prompts across multiple languages to guide users in utilizing the feature effectively.
- Enhanced the automations section with new examples for various use cases, improving user engagement and understanding.
2026-05-31 18:32:28 -07:00
DESKTOP-RTLN3BA\$punk
8005e6face chore(docs): remove AI Document Sorting from README files across multiple languages
- Removed the AI Document Sorting feature description from the README files in Spanish, Hindi, Portuguese, Chinese, and English.
- Updated the automations section to streamline content and focus on upcoming features.
2026-05-31 17:25:27 -07:00
DESKTOP-RTLN3BA\$punk
891d7b2a88 feat(docs): update README files with new use case categories and detailed descriptions
- Enhanced the structure of the README files across multiple languages to include new use case categories.
- Added detailed descriptions and media for features such as AI Report Generator, AI Podcast Generator, and more.
- Improved clarity and organization of existing features, ensuring consistency across all language versions.
- Introduced upcoming features and automation capabilities, highlighting their benefits and functionalities.
2026-05-31 17:21:24 -07:00
jimmyzhuu
e1acb7e7c3 docs: add Baidu Search connector guide 2026-04-28 10:11:07 +08:00
CREDO23
36d891d413 Update READMEs in all languages to describe Screenshot Assist instead of Extreme Assist. 2026-04-27 18:49:54 +02:00
DESKTOP-RTLN3BA\$punk
2cb30c604d try: ip fix for cludflare
- Introduced AI File Sorting functionality to automatically organize documents into a smart folder hierarchy based on source, date, and topic.
- Updated README.md to include the new feature.
- Enhanced homepage components with new illustrations and descriptions for AI File Sorting.
- Refactored rate limiting logic to extract real client IPs more accurately.
2026-04-16 02:13:52 -07:00
DESKTOP-RTLN3BA\$punk
e7041a279b feat: add "Watch Local Folder" feature to README files
- Updated README files in multiple languages to include the new "Watch Local Folder" feature for the desktop app, enhancing user understanding of its functionality.
- Added corresponding GIFs to visually demonstrate the feature across all language-specific documentation.
2026-04-07 19:17:01 -07:00
DESKTOP-RTLN3BA\$punk
86d48206dd feat: update README and hero section with new desktop app feature
- Enhanced README files in multiple languages to include the new "Watch Local Folder" feature for the desktop app, detailing its functionality and benefits.
- Updated the hero section to showcase the "Watch Local Folder" feature with a new tutorial video.
- Improved overall clarity and consistency across documentation regarding desktop app capabilities.
2026-04-07 18:59:40 -07:00
DESKTOP-RTLN3BA\$punk
4e3aae44f6 feat: update README files with new GIFs and content
- Replaced outdated GIF links with new ones for various features in all language-specific README files.
- Added new sections for desktop app functionalities, including General Assist, Quick Assist, and Extreme Assist.
- Enhanced visual content to improve user engagement and clarity of features.
2026-04-07 17:14:03 -07:00
DESKTOP-RTLN3BA\$punk
1a6251eaaa feat: add desktop app section to README files
- Introduced a new section in the README files for the Desktop App, highlighting its features: General Assist, Quick Assist, and Extreme Assist.
- Updated all language-specific README files to include details about the desktop app's capabilities and download instructions.
2026-04-07 16:56:08 -07:00
DESKTOP-RTLN3BA\$punk
9a370a37d4 docs: update README files to highlight SurfSense advantages over NotebookLM
- Expanded sections detailing limitations of NotebookLM.
- Added comparison table between SurfSense and Google NotebookLM.
- Enhanced descriptions of SurfSense features and capabilities.
- Updated example links and images for better clarity and relevance.
2026-04-02 20:06:02 -07:00
DESKTOP-RTLN3BA\$punk
c21d7dac3f feat: update README files to include OneDrive and Dropbox as external sources
Some checks are pending
Build and Push Docker Images / tag_release (push) Waiting to run
Build and Push Docker Images / build (./surfsense_backend, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_backend, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_web, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-24.04-arm, linux/arm64, arm64) (push) Blocked by required conditions
Build and Push Docker Images / build (./surfsense_web, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-latest, linux/amd64, amd64) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (backend, surfsense-backend) (push) Blocked by required conditions
Build and Push Docker Images / create_manifest (web, surfsense-web) (push) Blocked by required conditions
2026-03-31 22:36:58 -07:00
Rohan Verma
af5215fa44
Update video link in README.md 2026-03-22 18:20:47 -07:00
DESKTOP-RTLN3BA\$punk
08e68c16c7 Update README files to reflect changes in video and podcast agent examples, add video generation and presentation features, and update demo links and images across multiple languages. 2026-03-22 01:00:17 -07:00
Rohan Verma
2e1616ad91
Update README with demo and video agent sections 2026-03-22 00:38:44 -07:00
Rohan Verma
18c9a39345
Update images in README for connectors and uploads 2026-03-17 20:36:48 -07:00
DESKTOP-RTLN3BA\$punk
45cc527d02 feat: update report generation and export capabilities to support multiple formats (PDF, DOCX, HTML, LaTeX, EPUB, ODT, plain text) across documentation and backend 2026-03-09 18:41:21 -07:00