Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propose a new docs outline v2 #2510

Closed
ryscheng opened this issue Nov 22, 2024 · 4 comments
Closed

Propose a new docs outline v2 #2510

ryscheng opened this issue Nov 22, 2024 · 4 comments
Assignees
Labels
c:docs Blogs, documentation, and copy
Milestone

Comments

@ryscheng
Copy link
Member

What is it?

Our current docs are a big step forward from what we had previously, but still fall short of a seamless portal for new contributors.

Some ideas of what can be improved:

  • We should have better tutorials centered around intents (I want to be able to XYZ)
  • We should make better threads for certain contributor personas that are easy to follow. Right now Getting Started conflates a lot of things
  • The model space is really complex, and we don't have nearly enough documentation to help folks understand which model they should use for what

Some docs to take inspiration from include Stripe and Deno

@ryscheng ryscheng added this to the [f] Docs v2 milestone Nov 22, 2024
@github-project-automation github-project-automation bot moved this to Backlog in OSO Nov 22, 2024
@ccerv1
Copy link
Member

ccerv1 commented Nov 22, 2024

Copying over my notes:

  • Intro
  • Get Started
    • API
    • BigQuery
    • Python SDK [soon]
  • Add Your Project
    • Search For Artifacts Linked to Your Project
    • Update Artifacts
    • Get Metrics
    • Troubleshoot Data Issues
  • Get Data
    • Public Datasets
    • API
    • BigQuery
    • Static Datasets
  • Contribute Data
    • Connect Your Database
    • Crawl an API
    • Upload Static Data
  • Use Case Examples
    • Funder View
    • Developer Retention
    • Cohort Analysis
    • Synthetic Controls
    • Trusted Users
    • Network Graphs
    • OpenRank
    • ROI Analysis
  • Guides
    • oss-directory
      • Adding Projects
      • Adding Collections
      • Migrations
    • oss-funding
      • Adding Funders
      • Adding Rounds
      • Mapping Projects to Rounds
      • Integrating with DAOIP-5
    • dagster
    • dbt
    • SQL Mesh
    • Operations
    • Connecting OSO to Dashboarding Tools
      • Hex
      • Looker
      • Streamlit
      • Metabase
      • Tableau
    • Connecting OSO to Data Science Tools
      • Jupyter Notebook
      • Google Colab
  • Reference
    • Technical Architecture
    • Event Sources
    • Event Types
    • Impact Metrics
    • Models
    • Code Style Conventions
    • FAQs
  • Work With Us
    • Careers
    • Bounties
  • Talks
  • Subscribe for Updates

@ccerv1 ccerv1 self-assigned this Nov 25, 2024
@ccerv1 ccerv1 closed this as completed Nov 25, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in OSO Nov 25, 2024
@ryscheng ryscheng reopened this Nov 27, 2024
@github-project-automation github-project-automation bot moved this from Done to Needs Review in OSO Nov 27, 2024
@ryscheng
Copy link
Member Author

Can we leave this open while we're iterating on the doc?

@ryscheng ryscheng self-assigned this Nov 27, 2024
@ccerv1 ccerv1 added the c:docs Blogs, documentation, and copy label Dec 2, 2024
@ryscheng
Copy link
Member Author

ryscheng commented Dec 4, 2024

Did an edit pass in the doc. Generally I like the move towards more intent-based organization

@ryscheng ryscheng closed this as completed Dec 4, 2024
@github-project-automation github-project-automation bot moved this from Needs Review to Done in OSO Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c:docs Blogs, documentation, and copy
Projects
Status: Done
Development

No branches or pull requests

2 participants