Skip to content

chore(docs): added TextView section #24

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Jan 15, 2025
Merged

chore(docs): added TextView section #24

merged 7 commits into from
Jan 15, 2025

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Jan 15, 2025 •
edited by sourcery-ai bot
Loading

Changed

Fixed

Added

  • added TextView section on README.md

Tests

Tasks to complete before merging PR:

  • Ensure unit tests are passing. If not run make unit-test to check for any regressions 📋
  • Ensure lint tests are passing. if not run make lint to check for any issues
  • Ensure codecov/patch is passing for changes.

Summary by Sourcery

Add documentation for text views, describing how to create and render them with data models. Update descriptions for views, layouts, and pages.

Enhancements:

  • Clarify the descriptions of views, layouts, and pages.

Documentation:

  • Document text views, including creation and rendering with data models.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Jan 15, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request adds documentation for the new TextView feature. It explains how to create and render text views with data models, including examples and code snippets.

Sequence diagram for TextView rendering process

sequenceDiagram
    actor Client
    participant Router
    participant Context
    participant TextView
    participant Template

    Client->>Router: GET /sitemap.xml
    Note over Client: Accept: application/xml
    Router->>Context: Handle Request
    Context->>TextView: View(DataModel)
    TextView->>Template: Parse template
    Template->>TextView: Return parsed template
    TextView->>TextView: Apply DataModel
    TextView->>Context: Return rendered content
    Context->>Client: HTTP 200 OK<br/>Content-Type: text/xml
Loading

File-Level Changes

Change Details Files
Added a new section to the README.md file that describes the TextView feature.
  • Added a description of text views and their purpose.
  • Included instructions on how to create a text view within the project structure.
  • Provided an example of rendering a text view with a data model in Go.
  • Showed how to use curl to test the text view rendering with different accept headers.
  • Added information about multiple viewers and how response rendering is determined by the request's Accept header, including how to override the default viewer.
 README.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@deepsource-io deepsource.io
Copy link

deepsource-io bot commented Jan 15, 2025 •
edited
Loading

Here's the code health analysis summary for commits 259a657..06ebcfb. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Go LogoGo✅ SuccessView Check ↗
💡 If you’re a repository administrator, you can configure the quality gates from the settings.

sourcery-ai[bot]
sourcery-ai bot reviewed Jan 15, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @cnlangzi - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov Codecov
Copy link

codecov bot commented Jan 15, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.79%. Comparing base (259a657) to head (06ebcfb).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #24   +/-   ##
=======================================
  Coverage   89.79%   89.79%           
=======================================
  Files          32       32           
  Lines        1176     1176           
=======================================
  Hits         1056     1056           
  Misses         83       83           
  Partials       37       37
Flag Coverage Δ
Unit-Tests 89.79% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cnlangzi cnlangzi merged commit 8ffc9c5 into main Jan 15, 2025
7 checks passed
@cnlangzi cnlangzi deleted the docs/text branch January 15, 2025 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cnlangzi