forem
YARD
forem | YARD | |
---|---|---|
198 | 18 | |
21,585 | 1,905 | |
0.3% | - | |
9.8 | 6.5 | |
about 14 hours ago | about 1 month ago | |
Ruby | Ruby | |
GNU Affero General Public License v3.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
forem
-
Deploying Forem on Render.com PromptZone.com
The journey of deploying an open-source software platform like forem can be complex and daunting, but with the right tools and services, it can also be remarkably rewarding. This article details my experience deploying Forem, the software behind the Dev.to, on Render.com, deploying Promptzone.com.
-
Lesser Known Features of DEV β Embeds!
In the future, I think we will probs make this uniform with the others. I've logged this request here on GitHub... hmmm, maybe I should embed it here instead. π
-
I fixed the "Save draft" Button on dev.to - No Accidental Publishing Anymore π
I even opened a discussion, which got no responses so far (which I think existed somewhere else or I am the only one with this issue...).
-
What are you learning about this weekend? π§
Whether you're sharpening your JS skills, making PRs to your OSS repo of choice π, sprucing up your portfolio, or writing a new post here on DEV, we'd like to hear about it.
-
Tackling Clickbait on DEV: Strategy and Technical Approach
Add articles clickbait_score as factor in final feed ordering #20493
-
Crushing it: My New Year's Resolutions for 2024
Do more documentation-related and code contributions to Forem's repository
-
πΊπΌ My life update and the Open Source #DEVImpact2023
This year again, I contributed to DEV with multiples ways, I've contributed very little to the repository, moderated the bad posts quite a bit, and welcomed newcomers to the platform. I feel that a place like this should always be so welcoming to users, so why shouldn't I?
-
π #DEVImpact2023: A Year of Challenges, Triumphs, and The Future
docs: making updates to Editor Guide #20258
-
Open Source alternatives to tools you Pay for
Forem - Open Source Alternative to Circle
-
What you learning about this weekend? π§
Whether you're sharpening your JS skills, making PRs to your OSS repo of choice π, sprucing up your portfolio, or writing a new post here on DEV, we'd like to hear about it.
YARD
-
What is JSDoc and why you may not need typescript for your next project?
JSDOC is a predefined method of documenting code for javascript ecosystem created in 1999 that works similar to libraries for other languages such as: Javadoc for java, YARD for ruby, etc..
-
Xeme: I'd value your opinion on my new Ruby gem
In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.
-
Programming types and mindsets
I still just document everything using YARD and focus on designing really obvious Object Models and of course write tests. I have tried using sord to convert my YARD type annotations to RBS or RBI, but you still have to fill in missing bits, then use steep and somehow load in RBS/RBI files for other gems and stdlib, and it's just an uphill battle since Ruby is dynamically typed by default. Obviously Dynamic Typing lends itself more to Dynamic Languages, where you can call an arbitrary method and let the language VM figure it out at runtime. Static or Strong Typing lends itself better to compiled languages where everything needs to be resolved at compile time and converted into object code. If I need to work in a compiled language, then I'll use Crystal, which also supports type inference. TypeScript's type syntax is quite nice, but I tend to avoid writing massive JavaScript code bases where a Type Checker helps catch subtle bugs, and instead prefer sticking to minimal amounts of vanilla JavaScriot in order to keep complexity low and not overwhelm the browser.
-
kwargs and YARD: @param or @option?
I had a dig into the file history, and it looks like we have to go back to 0.7 to find the old tag list. Here we find the info we need to understand the intent of the @option tag:
-
Comparing RDoc, YARD, and SDoc: Choosing the Right Documentation Generator for Your Ruby on Rails 5 Project
YARD: http://yardoc.org/
-
How do you document your code?
I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.
-
The right is on the left
That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).
-
#buildinpublic, issue 1: building API documentation browser for command line
My first assumption was, that I should be able to generate markdown from the source. Same ruby and rails does now, but only tweaking a couple of parameters to generate .md files instead. YARD is being used for that and it supports any markup rdoc or yard.
-
The Why and How of Yardoc
Iβve long used the YARD format and chose to use that as my documentation syntax. I suppose I didnβt check with anyone on this decision and slowly started adding documentation. I want to use this post to synthesize my implicit decision and the benefits of using Yard as the documentation format.
-
Graphic representation of class / module inheritance in Rails?
That said, YARD is a ruby documentation tool that has a yard graph command you can use to dump a UML graph for your app into a .dot file, which can be used with lots of different graphing tools (usually graphviz but there are a bunch of online tools and open source projects that can visualize them for you).
What are some alternatives?
Discourse - A platform for community discussion. Free, open, simple.
RDoc - RDoc produces HTML and online documentation for Ruby projects.
ComfyJS - Comfiest Twitch Chat Library for JavaScript | NodeJS + Browser Support
Apipie - Ruby on Rails API documentation tool
klipse - Klipse is a JavaScript plugin for embedding interactive code snippets in tech blogs.
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
reactor - Phoenix LiveView but for Django
Asciidoctor - :gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
ghost-on-heroku - One-button Heroku deploy for the Ghost 3.2.0 blogging platform.
Annotate - Annotate Rails classes with schema and routes info
Ruby on Rails - Ruby on Rails
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.