Skip to content

docs: fix datasources/getting-started/page.md template syntax for proper GitHub rendering #1909

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

Closed
wants to merge 1 commit into from

Conversation

olxandr
Copy link
Contributor

@olxandr olxandr commented Jun 27, 2025

Fixes #1929

Description:

  • The datasources/getting-started/page.md file contains template syntax {% table %} that doesn't render properly on GitHub, making the documentation appear broken and unprofessional to visitors. This PR addresses this issue by fixing the markup so it renders properly.

Additional Information:

  • Before:
    Screenshot 2025-06-27 225853

  • After:
    Screenshot 2025-06-27 225927

Checklist:

  • This PR does not decrease the overall code coverage.
  • I have reviewed the code comments and documentation for clarity.

@olxandr olxandr changed the title docs: fix getting-started/page.md template syntax for proper GitHub r… docs: fix getting-started/page.md template syntax for proper GitHub rendering Jun 27, 2025
@olxandr olxandr marked this pull request as draft June 28, 2025 19:17
@olxandr olxandr changed the title docs: fix getting-started/page.md template syntax for proper GitHub rendering docs: fix datasources/getting-started/page.md template syntax for proper GitHub rendering Jun 28, 2025
@olxandr olxandr marked this pull request as ready for review June 28, 2025 19:22
@Umang01-hash
Copy link
Member

@olxandr This change will hinder the rendering of this table on the gofr.dev website. We should avoid it. The pages in the webiste docs section is rendered through the gofr's repo doc, that is why we have inserted the table in such specific format.

Thanks for the understanding. Closing it as of now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs/datasources/getting-started/page.md broken template syntax
2 participants