openvibers/openvibe.help Commits
openvibe-shared v4.108.0 (was v4.107.4) (#199)
Changes
@@@ -281,6 +281,6 @@ Part of the [OpenVibe network](https://openvibe.network). Built in the open by [<!-- versions:start -->- openvibe-contracts: v0.222.0- openvibe-sdk: v0.82.0--- openvibe-shared: v4.107.4++- openvibe-shared: v4.108.0- openvibe-publishing: v1.4.0<!-- versions:end -->@@@ -9,11 +9,11 @@"domain": "openvibe.help","contracts": "openvibe-contracts v0.222.0","sdk": "openvibe-sdk v0.82.0",-- "shared": "openvibe-shared v4.107.4",++ "shared": "openvibe-shared v4.108.0","packages": ["openvibe-contracts v0.222.0","openvibe-sdk v0.82.0",-- "openvibe-shared v4.107.4",++ "openvibe-shared v4.108.0","openvibe-publishing v1.4.0"],"summary": "The help and support centre for every OpenVibe site. The help centre is generated at boot from openvibe-contracts (every product manifest and every service manifest's site block): one page per site, one page per question, each text quoted verbatim with its manifest named. /search searches those articles with a fixed explainable score and the network through OpenVibe.Search's public API (cached 5 minutes, degrading to the articles alone when it fails). A signed-in person opens a support ticket that stays one conversation — site, subject, message, an optional page URL stored as text and never fetched — sees only their own, and replies; staff by their Network role claim read the queue, filter it and set the state. Tickets live in PostgreSQL (migrations/0002_tickets.sql), writes made with the session cookie must be same-origin, and opening and answering are limited per caller. Sign-in is OpenVibe.Network (OAuth 2 + PKCE), the pages are server-rendered through the OpenVibe Frame and work without JavaScript, and the crawl artifacts cover every site and every question.",@@@ -18,7 +18,7 @@"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.222.0","openvibe-publishing": "https://codeload.github.com/OpenVibers/OpenVibe.Publishing/tar.gz/refs/tags/v1.4.0","openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.82.0",-- "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.107.4",++ "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.108.0","pg": "^8.23.0"},"devDependencies": {@@@ -1209,9 +1209,9 @@}},"node_modules/openvibe-shared": {-- "version": "4.107.4",-- "resolved": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.107.4",-- "integrity": "sha512-tThN0m3KMncEHVcBOvE+ysHjsZTlVIDLG1P+/i2Mulmxfc/AUpebAXhpWWrut50OChZ8o+HeePxsSrPI8mUQOQ==",++ "version": "4.108.0",++ "resolved": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.108.0",++ "integrity": "sha512-NPzwjxpzGIpFpIm4uw3+VwHfsxbJ2+cD9yuhRzSwolSwqv2kCmwaVtHJ0DA9gKO3K8PCBfIP3UpKzpuSbYEJ+g==","license": "MIT","dependencies": {"jsonwebtoken": "^9.0.0",@@@ -25,7 +25,7 @@"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.222.0","openvibe-publishing": "https://codeload.github.com/OpenVibers/OpenVibe.Publishing/tar.gz/refs/tags/v1.4.0","openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.82.0",-- "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.107.4",++ "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.108.0","pg": "^8.23.0"},"engines": {@@@ -74,9 +74,13 @@ function createDiscoveryRoutes(ctx) {+ `# Agent manifest: ${abs('/.well-known/agent.json')}\n`);});++ // Every one of Help's own pages is linked at its Markdown twin (AGT-5; openvibe-shared 4.108.0 leaves /api/ paths++ // and other sites' links as they are). What an agent may skip for a shorter context is in `optional`, last.r.get('/llms.txt', (_req, res) => {res.type('text/plain').set('Cache-Control', TEXT).send(seo.llmsTxt({name: SITE_NAME,++ markdown: true,++ base: site,summary: 'OpenVibe.Help: the help and support centre for every OpenVibe site. The answers are generated from OpenVibe.Contracts at boot — each site\'s own manifest, verbatim — so a page here is the product\'s own words, with a link back to where they were read.',details: 'Every site and every question is a page: /sites lists them, /sites/<domain> is one site with its pillars and its questions, and /a/<domain>/<slug> is one question with its answer. /search searches those answers and the network through OpenVibe.Search. Signed in, a person can open a support ticket; the ticket and its conversation are private to them (and to OpenVibe staff). Every page is server-rendered and readable without JavaScript.',sections: [@@@ -91,15 +95,16 @@ function createDiscoveryRoutes(ctx) {{ title: 'Every site (JSON)', url: abs('/api/v1/sites') },{ title: 'One site (JSON)', url: abs(`/api/v1/sites/${catalog.sites[0] ? catalog.sites[0].id : 'openvibe.network'}`) },{ title: 'The articles (JSON, ?q= ranks them)', url: abs('/api/v1/articles?q=live') },-- { title: 'Sitemap', url: abs('/sitemap.xml') },-- { title: 'Full text for language models', url: abs('/llms-full.txt') },{ title: 'Release metadata (JSON)', url: abs('/release.json') },] },-- { title: 'Elsewhere', links: [-- { title: 'OpenVibe.Search', url: 'https://search.openvibe.network', note: 'the network\'s own index, the "From across OpenVibe" half of /search' },-- { title: 'OpenVibe.Services', url: 'https://openvibe.services', note: 'apps, keys and capability grants' },-- { title: 'OpenVibe.Network', url: 'https://openvibe.network', note: 'accounts, apps and grants' },-- ] },++ ],++ // llmstxt.org's "## Optional": what an agent may skip when it needs a shorter context.++ optional: [++ { title: 'Sitemap', url: abs('/sitemap.xml') },++ { title: 'Full text for language models', url: abs('/llms-full.txt') },++ { title: 'OpenVibe.Search', url: 'https://search.openvibe.network', note: 'the network\'s own index, the "From across OpenVibe" half of /search' },++ { title: 'OpenVibe.Services', url: 'https://openvibe.services', note: 'apps, keys and capability grants' },++ { title: 'OpenVibe.Network', url: 'https://openvibe.network', note: 'accounts, apps and grants' },],}));});@@@ -48,7 +48,10 @@ const PRIVATE = ['/auth/', '/api/'];assert.match(r.headers.get('content-type'), /^text\/plain/);assert.match(r.headers.get('cache-control') || '', /public, max-age=\d+/);assert.ok(r.text.startsWith('# OpenVibe.Help'), 'no title');-- assert.ok(r.text.includes('(https://openvibe.help/updates)'), 'no updates link');++ // AGT-5: each of Help's own pages is linked at its Markdown twin, and the secondary links are Optional.++ assert.ok(r.text.includes('(https://openvibe.help/index.md)'), 'the home link is not its twin');++ assert.ok(r.text.includes('(https://openvibe.help/updates.md)'), 'no updates link');++ assert.ok(r.text.includes('\n## Optional\n'), 'no ## Optional section');assert.ok(r.text.includes('(https://openvibe.services)'), 'no pointer to the developer platform');assert.ok(r.text.includes('https://openvibe.help/sitemap.xml'), 'sitemap not listed');assert.ok(r.text.includes('(https://openvibe.help/llms-full.txt)'), 'llms-full.txt not listed');
@@ -281,6 +281,6 @@ Part of the [OpenVibe network](https://openvibe.network). Built in the open by [
@@ -281,6 +281,6 @@ Part of the [OpenVibe network](https://openvibe.network). Built in the open by [
<!-- versions:start -->
<!-- versions:start -->
- openvibe-contracts: v0.222.0
- openvibe-contracts: v0.222.0
- openvibe-sdk: v0.82.0
- openvibe-sdk: v0.82.0
-- openvibe-shared: v4.107.4
+- openvibe-shared: v4.108.0
- openvibe-publishing: v1.4.0
- openvibe-publishing: v1.4.0
<!-- versions:end -->
<!-- versions:end -->
@@ -9,11 +9,11 @@
@@ -9,11 +9,11 @@
"domain": "openvibe.help",
"domain": "openvibe.help",
"contracts": "openvibe-contracts v0.222.0",
"contracts": "openvibe-contracts v0.222.0",
"sdk": "openvibe-sdk v0.82.0",
"sdk": "openvibe-sdk v0.82.0",
- "shared": "openvibe-shared v4.107.4",
+ "shared": "openvibe-shared v4.108.0",
"packages": [
"packages": [
"openvibe-contracts v0.222.0",
"openvibe-contracts v0.222.0",
"openvibe-sdk v0.82.0",
"openvibe-sdk v0.82.0",
- "openvibe-shared v4.107.4",
+ "openvibe-shared v4.108.0",
"openvibe-publishing v1.4.0"
"openvibe-publishing v1.4.0"
],
],
"summary": "The help and support centre for every OpenVibe site. The help centre is generated at boot from openvibe-contracts (every product manifest and every service manifest's site block): one page per site, one page per question, each text quoted verbatim with its manifest named. /search searches those articles with a fixed explainable score and the network through OpenVibe.Search's public API (cached 5 minutes, degrading to the articles alone when it fails). A signed-in person opens a support ticket that stays one conversation — site, subject, message, an optional page URL stored as text and never fetched — sees only their own, and replies; staff by their Network role claim read the queue, filter it and set the state. Tickets live in PostgreSQL (migrations/0002_tickets.sql), writes made with the session cookie must be same-origin, and opening and answering are limited per caller. Sign-in is OpenVibe.Network (OAuth 2 + PKCE), the pages are server-rendered through the OpenVibe Frame and work without JavaScript, and the crawl artifacts cover every site and every question.",
"summary": "The help and support centre for every OpenVibe site. The help centre is generated at boot from openvibe-contracts (every product manifest and every service manifest's site block): one page per site, one page per question, each text quoted verbatim with its manifest named. /search searches those articles with a fixed explainable score and the network through OpenVibe.Search's public API (cached 5 minutes, degrading to the articles alone when it fails). A signed-in person opens a support ticket that stays one conversation — site, subject, message, an optional page URL stored as text and never fetched — sees only their own, and replies; staff by their Network role claim read the queue, filter it and set the state. Tickets live in PostgreSQL (migrations/0002_tickets.sql), writes made with the session cookie must be same-origin, and opening and answering are limited per caller. Sign-in is OpenVibe.Network (OAuth 2 + PKCE), the pages are server-rendered through the OpenVibe Frame and work without JavaScript, and the crawl artifacts cover every site and every question.",
@@ -18,7 +18,7 @@
@@ -18,7 +18,7 @@
"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.222.0",
"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.222.0",
"openvibe-publishing": "https://codeload.github.com/OpenVibers/OpenVibe.Publishing/tar.gz/refs/tags/v1.4.0",
"openvibe-publishing": "https://codeload.github.com/OpenVibers/OpenVibe.Publishing/tar.gz/refs/tags/v1.4.0",
"openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.82.0",
"openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.82.0",
- "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.107.4",
+ "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.108.0",
"pg": "^8.23.0"
"pg": "^8.23.0"
},
},
"devDependencies": {
"devDependencies": {
@@ -1209,9 +1209,9 @@
@@ -1209,9 +1209,9 @@
}
}
},
},
"node_modules/openvibe-shared": {
"node_modules/openvibe-shared": {
- "version": "4.107.4",
- "resolved": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.107.4",
- "integrity": "sha512-tThN0m3KMncEHVcBOvE+ysHjsZTlVIDLG1P+/i2Mulmxfc/AUpebAXhpWWrut50OChZ8o+HeePxsSrPI8mUQOQ==",
+ "version": "4.108.0",
+ "resolved": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.108.0",
+ "integrity": "sha512-NPzwjxpzGIpFpIm4uw3+VwHfsxbJ2+cD9yuhRzSwolSwqv2kCmwaVtHJ0DA9gKO3K8PCBfIP3UpKzpuSbYEJ+g==",
"license": "MIT",
"license": "MIT",
"dependencies": {
"dependencies": {
"jsonwebtoken": "^9.0.0",
"jsonwebtoken": "^9.0.0",
@@ -25,7 +25,7 @@
@@ -25,7 +25,7 @@
"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.222.0",
"openvibe-contracts": "https://codeload.github.com/OpenVibers/OpenVibe.Contracts/tar.gz/refs/tags/v0.222.0",
"openvibe-publishing": "https://codeload.github.com/OpenVibers/OpenVibe.Publishing/tar.gz/refs/tags/v1.4.0",
"openvibe-publishing": "https://codeload.github.com/OpenVibers/OpenVibe.Publishing/tar.gz/refs/tags/v1.4.0",
"openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.82.0",
"openvibe-sdk": "https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.82.0",
- "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.107.4",
+ "openvibe-shared": "https://codeload.github.com/OpenVibers/OpenVibe.Shared/tar.gz/refs/tags/v4.108.0",
"pg": "^8.23.0"
"pg": "^8.23.0"
},
},
"engines": {
"engines": {
@@ -74,9 +74,13 @@ function createDiscoveryRoutes(ctx) {
@@ -74,9 +74,13 @@ function createDiscoveryRoutes(ctx) {
+ `# Agent manifest: ${abs('/.well-known/agent.json')}\n`);
+ `# Agent manifest: ${abs('/.well-known/agent.json')}\n`);
});
});
+ // Every one of Help's own pages is linked at its Markdown twin (AGT-5; openvibe-shared 4.108.0 leaves /api/ paths
+ // and other sites' links as they are). What an agent may skip for a shorter context is in `optional`, last.
r.get('/llms.txt', (_req, res) => {
r.get('/llms.txt', (_req, res) => {
res.type('text/plain').set('Cache-Control', TEXT).send(seo.llmsTxt({
res.type('text/plain').set('Cache-Control', TEXT).send(seo.llmsTxt({
name: SITE_NAME,
name: SITE_NAME,
+ markdown: true,
+ base: site,
summary: 'OpenVibe.Help: the help and support centre for every OpenVibe site. The answers are generated from OpenVibe.Contracts at boot — each site\'s own manifest, verbatim — so a page here is the product\'s own words, with a link back to where they were read.',
summary: 'OpenVibe.Help: the help and support centre for every OpenVibe site. The answers are generated from OpenVibe.Contracts at boot — each site\'s own manifest, verbatim — so a page here is the product\'s own words, with a link back to where they were read.',
details: 'Every site and every question is a page: /sites lists them, /sites/<domain> is one site with its pillars and its questions, and /a/<domain>/<slug> is one question with its answer. /search searches those answers and the network through OpenVibe.Search. Signed in, a person can open a support ticket; the ticket and its conversation are private to them (and to OpenVibe staff). Every page is server-rendered and readable without JavaScript.',
details: 'Every site and every question is a page: /sites lists them, /sites/<domain> is one site with its pillars and its questions, and /a/<domain>/<slug> is one question with its answer. /search searches those answers and the network through OpenVibe.Search. Signed in, a person can open a support ticket; the ticket and its conversation are private to them (and to OpenVibe staff). Every page is server-rendered and readable without JavaScript.',
sections: [
sections: [
@@ -91,15 +95,16 @@ function createDiscoveryRoutes(ctx) {
@@ -91,15 +95,16 @@ function createDiscoveryRoutes(ctx) {
{ title: 'Every site (JSON)', url: abs('/api/v1/sites') },
{ title: 'Every site (JSON)', url: abs('/api/v1/sites') },
{ title: 'One site (JSON)', url: abs(`/api/v1/sites/${catalog.sites[0] ? catalog.sites[0].id : 'openvibe.network'}`) },
{ title: 'One site (JSON)', url: abs(`/api/v1/sites/${catalog.sites[0] ? catalog.sites[0].id : 'openvibe.network'}`) },
{ title: 'The articles (JSON, ?q= ranks them)', url: abs('/api/v1/articles?q=live') },
{ title: 'The articles (JSON, ?q= ranks them)', url: abs('/api/v1/articles?q=live') },
- { title: 'Sitemap', url: abs('/sitemap.xml') },
- { title: 'Full text for language models', url: abs('/llms-full.txt') },
{ title: 'Release metadata (JSON)', url: abs('/release.json') },
{ title: 'Release metadata (JSON)', url: abs('/release.json') },
] },
] },
- { title: 'Elsewhere', links: [
- { title: 'OpenVibe.Search', url: 'https://search.openvibe.network', note: 'the network\'s own index, the "From across OpenVibe" half of /search' },
- { title: 'OpenVibe.Services', url: 'https://openvibe.services', note: 'apps, keys and capability grants' },
- { title: 'OpenVibe.Network', url: 'https://openvibe.network', note: 'accounts, apps and grants' },
- ] },
+ ],
+ // llmstxt.org's "## Optional": what an agent may skip when it needs a shorter context.
+ optional: [
+ { title: 'Sitemap', url: abs('/sitemap.xml') },
+ { title: 'Full text for language models', url: abs('/llms-full.txt') },
+ { title: 'OpenVibe.Search', url: 'https://search.openvibe.network', note: 'the network\'s own index, the "From across OpenVibe" half of /search' },
+ { title: 'OpenVibe.Services', url: 'https://openvibe.services', note: 'apps, keys and capability grants' },
+ { title: 'OpenVibe.Network', url: 'https://openvibe.network', note: 'accounts, apps and grants' },
],
],
}));
}));
});
});
@@ -48,7 +48,10 @@ const PRIVATE = ['/auth/', '/api/'];
@@ -48,7 +48,10 @@ const PRIVATE = ['/auth/', '/api/'];
assert.match(r.headers.get('content-type'), /^text\/plain/);
assert.match(r.headers.get('content-type'), /^text\/plain/);
assert.match(r.headers.get('cache-control') || '', /public, max-age=\d+/);
assert.match(r.headers.get('cache-control') || '', /public, max-age=\d+/);
assert.ok(r.text.startsWith('# OpenVibe.Help'), 'no title');
assert.ok(r.text.startsWith('# OpenVibe.Help'), 'no title');
- assert.ok(r.text.includes('(https://openvibe.help/updates)'), 'no updates link');
+ // AGT-5: each of Help's own pages is linked at its Markdown twin, and the secondary links are Optional.
+ assert.ok(r.text.includes('(https://openvibe.help/index.md)'), 'the home link is not its twin');
+ assert.ok(r.text.includes('(https://openvibe.help/updates.md)'), 'no updates link');
+ assert.ok(r.text.includes('\n## Optional\n'), 'no ## Optional section');
assert.ok(r.text.includes('(https://openvibe.services)'), 'no pointer to the developer platform');
assert.ok(r.text.includes('(https://openvibe.services)'), 'no pointer to the developer platform');
assert.ok(r.text.includes('https://openvibe.help/sitemap.xml'), 'sitemap not listed');
assert.ok(r.text.includes('https://openvibe.help/sitemap.xml'), 'sitemap not listed');
assert.ok(r.text.includes('(https://openvibe.help/llms-full.txt)'), 'llms-full.txt not listed');
assert.ok(r.text.includes('(https://openvibe.help/llms-full.txt)'), 'llms-full.txt not listed');