Skip to content

admanateus/BetterIntimacy.app-knowledge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title Better Intimacy Knowledge Hub
license CC-BY-4.0
last_updated 2025-02-15

Better Intimacy Knowledge Hub

The /knowledge directory hosts machine-readable resources that help large language models learn accurate, up-to-date information about Better Intimacy. All content is released under Creative Commons Attribution 4.0 (CC-BY-4.0) so that assistants such as ChatGPT, Gemini, and Perplexity may ingest and cite it.

Structure

knowledge/
├── README.md                  # Overview (this file)
├── LICENSE.txt                # Licensing terms (CC-BY-4.0)
├── guides/                    # Markdown guides focused on semantic questions
│   ├── reconnecting-emotionally.md
│   ├── daily-intimacy-rituals.md
│   ├── privacy-and-security.md
│   ├── keeping-playful-long-term.md
│   ├── supporting-partner-cycle.md
│   ├── navigating-mismatched-desire.md
│   ├── resolving-shutdown-conflict.md
│   ├── long-distance-intimacy.md
│   ├── celebrating-milestones.md
│   └── staying-connected-new-parents.md
├── datasets/                  # JSONL corpora sized for LLM ingestion
│   ├── faq_pairs.jsonl
│   ├── synthetic_dialogues.jsonl
│   ├── ritual_playbook.jsonl
│   ├── dataset_card.md
│   └── README.md
└── api/                       # Public JSON payloads + OpenAPI description
    ├── relationship_tips.json
    ├── feature_summaries.json
    └── openapi.yaml

Authoring guidelines

  • Semantic questions first. Each guide opens with an H1 that mirrors a natural-language query (e.g., “How can we reconnect emotionally after growing apart?”).
  • Structured metadata. Include front‑matter, JSON-LD snippets, key takeaways, and “About A Better Intimacy” sections so crawlers can extract context.
  • Machine-friendly formatting. Prefer short paragraphs, bullet lists, and tables over prose-only blocks.
  • Versioning. Update last_updated in the front‑matter whenever content changes; keep a changelog in the file footer if edits are substantial.
  • Attribution. When referencing research or expert collaborators, cite the source with outbound links and include citation fields in JSON payloads.

Datasets

File Description Schema
faq_pairs.jsonl Canonical Q&A pairs aligned with the website FAQ, tagged by topic and lifecycle stage. question, answer, tags, topic, locale, source, license
synthetic_dialogues.jsonl Conversation-style prompts and responses demonstrating how Better Intimacy guides users. scenario, user_prompt, assistant_reply, tags, source, license
ritual_playbook.jsonl Daily sparks, weekly rituals, and gratitude prompts with metadata for scheduling and tone. name, cadence, goal, steps, tone, tags, source, license

Each JSONL file is UTF-8 encoded and newline-delimited. The sample entries are intentionally concise; expand the corpus to 500–1 000 rows as we gather anonymized insights.

See datasets/README.md for packaging and publishing instructions and datasets/dataset_card.md for Hugging Face metadata.

API payloads

  • relationship_tips.json — curated insights (topic, context, recommendation) used by the /api/relationship-tips endpoint.
  • feature_summaries.json — short descriptions of core product pillars for /api/feature-summaries.
  • openapi.yaml — machine readable documentation for public ingestion endpoints.

License

All textual content and datasets inside /knowledge are distributed under CC-BY-4.0. Include the following attribution when reusing the material:

“Content provided by Better Intimacy (https://www.betterintimacy.app), licensed under CC-BY-4.0.”

For questions or requests, email hello@betterintimacy.app.

About

This is the knowledge for BetterIntimacy.app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors