Skip to content

Commit

Permalink
Merge branch 'main' into vargas/publish-python-ast
Browse files Browse the repository at this point in the history
  • Loading branch information
dannysheridan authored Nov 26, 2024
2 parents cbee68a + 2d64e0a commit c6d248e
Show file tree
Hide file tree
Showing 297 changed files with 152,677 additions and 8,051 deletions.
31 changes: 23 additions & 8 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
# General rule for everything
* @dsinghvi
fern/* @dsinghvi

# Specific rules for fern/
fern/docs.yml @chdeskur
fern/pages/* @chdeskur

# Specific rules for generators
generators/go/* @amckinney
generators/java/* @dcb6
generators/csharp/* @dcb6
generators/python/* @armandobelardo
generators/ruby/* @armandobelardo
generators/typescript/* @dsinghvi
generators/go-v2/* @amckinney
generators/php/* @amckinney
generators/commons/* @amckinney
generators/csharp/* @Swimburger
generators/typescript/* @Swimburger
generators/java/* @dsinghvi
generators/python/* @dsinghvi
generators/python-v2/* @dsinghvi
generators/ruby/* @dsinghvi
generators/swift/* @dsinghvi
generators/postman/* @dsinghvi
generators/openapi/* @dsinghvi

# Specific rules for packages
packages/cli/* @amckinney
packages/generators/cli/* @armandobelardo
packages/generators/docker/* @armandobelardo
packages/generators/cli/* @dsinghvi
packages/generators/docker/* @dsinghvi
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/cli.md

This file was deleted.

53 changes: 0 additions & 53 deletions .github/ISSUE_TEMPLATE/csharp

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/docs-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: "Docs Bug Report"
description: "Report a bug with Fern Docs"
labels:
- product/docs
- bug
assignees: dsheridan
body:
- type: markdown
attributes:
value: "Please provide the following details to help us reproduce and fix the issue."
- type: input
id: cli-version
attributes:
label: "CLI Version (from `fern.config.json`)"
placeholder: "e.g., 0.44.11"
validations:
required: true
- type: textarea
id: api-spec
attributes:
label: "Minimal API Specification"
description: "Provide the smallest API spec necessary to reproduce the issue. This helps us quickly understand the context of the bug."
placeholder: "Paste the API spec here..."
validations:
required: true
- type: textarea
id: actual-site
attributes:
label: "Actual UI Behavior"
description: "Describe what is currently happening in the UI. If possible, include a screenshot, Loom video, or any other visual aid to help us understand the issue."
placeholder: "Paste a screenshot, Loom video, or detailed description of the issue here..."
validations:
required: true
- type: textarea
id: expected-site
attributes:
label: "Expected UI Behavior"
description: "Describe what you expected the UI to do. Providing as much detail as possible helps us understand the difference between expected and actual behavior."
placeholder: "Describe the expected behavior, including any screenshots or visuals..."
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: "Steps to Reproduce"
description: "List the steps to reproduce the issue. This helps us replicate the problem on our end."
placeholder: "1. Go to ...\n2. Click on ...\n3. Observe the issue..."
validations:
required: false
- type: textarea
id: environment-details
attributes:
label: "Environment Details"
description: "Provide information about your environment, such as browser version, OS, and any other relevant details."
placeholder: "e.g., Chrome 90, macOS 12.1"
validations:
required: false
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/docs-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: "Docs Feature Request"
description: "Request a new feature for Fern Docs"
labels:
- product/docs
- feature
assignees: dsheridan
body:
- type: markdown
attributes:
value: "Have a feature idea for Fern Docs? Let us know why it's important and what it should look like!"
- type: textarea
id: feature-description
attributes:
label: "Feature Description"
description: "Explain in detail what the feature should do, how it will improve the user experience, and why it is needed. Provide specific examples if possible."
placeholder: "Describe the feature, its purpose, and the problem it solves..."
validations:
required: true
- type: textarea
id: use-case
attributes:
label: "Use Case"
description: "Provide a specific use case or scenario where this feature would be particularly useful."
placeholder: "Describe a situation where this feature would be helpful..."
validations:
required: true
- type: textarea
id: proposed-experience
attributes:
label: "Proposed Experience (Optional)"
description: "If possible, share what the UI or workflow should look like, including examples, diagrams, or screenshots."
placeholder: "Provide a description, diagram, screenshot, or leave blank if unsure..."
- type: textarea
id: alternatives-considered
attributes:
label: "Alternatives Considered (Optional)"
description: "If you've considered other solutions or workarounds, please describe them here."
placeholder: "Describe any alternative approaches you have thought of or tried..."
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/docs.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/documentation-suggestion.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: "Documentation Issue"
description: "Report an issue or suggest an improvement for the documentation"
labels:
- documentation
assignees: dsheridan
body:
- type: markdown
attributes:
value: "Help us improve our documentation by reporting an issue or suggesting an enhancement."
- type: input
id: page-url
attributes:
label: "Documentation Page URL"
description: "Provide the URL of the documentation page where you found the issue."
placeholder: "e.g., https://buildwithfern.com/learn/your-page"
validations:
required: true
- type: textarea
id: issue-description
attributes:
label: "Issue Description"
description: "Describe the issue or improvement in detail. Include any errors, inconsistencies, or areas of confusion."
placeholder: "Describe the issue here..."
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: "Steps to Reproduce (Optional)"
description: "Provide clear steps to help us reproduce the issue. This will help us understand the problem more easily."
placeholder: "1. Go to the page...\n2. Click on...\n3. Observe the issue..."
- type: textarea
id: suggested-improvement
attributes:
label: "Suggested Improvement"
description: "Propose how the documentation could be improved. Include specific changes or additional information that could be helpful."
placeholder: "Suggest an improvement or leave blank if unsure..."
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

Loading

0 comments on commit c6d248e

Please sign in to comment.