Comments (7)
To understand the internals of Pacto I would suggest to start self documenting code, then extract the comments from the source code to generate some documentation. Possible tool candidates can be found here https://www.ruby-toolbox.com/categories/documentation_tools.
One "nice" example of code annotated is underscore http://underscorejs.org/docs/underscore.html, there is a tool https://github.com/rtomayko/rocco that generates the same style of documentation for Ruby projects.
I just found this project https://github.com/rubyworks/qed/wiki that brings Literate programming for Ruby projects, still I would dig more about the topic before suggesting to use it for Pacto.
from pacto.
I'm a big fan of relishapp, which is used by rspec, cucumber, and vcr, among others.
It generates documentation from markdown and cucumber feature files. Needing to write cukes is a deal-breaker for some people, but I find it worth it for the documentation it generates. And obviously you can still keep the majority of your tests in rspec (or I doubt rspec would use relishapp).
Check out the linked examples and let me know what you think.
from pacto.
Let's use relishapp for generate final user documentation. Personally I found RSpec/Cucumber/Vcr documentation not easy to find using relishapp (their built in search tool sucks), but the advantage that I like is that generates the documentation based on the tests =). I believe that the search issue is related with the tool (I hope it will improve), but we can find a way to use relishapp in our favour.
from pacto.
Should we close this?
I think we just need to finish #36 (Contributor Guidelines), and make sure the release process includes publishing to relish.
from pacto.
Yeah, we can close it =)
from pacto.
That was fast.
Half of the problem was solved with Relish documentation (the documentation for final users).
The other part is documentation for contributors, my suggestion was to annotate the source code, currently the documentation is pretty empty see (here)[http://rubydoc.info/gems/pacto/frames].
What do you think?
from pacto.
I'd split them, based on the roadmap proposal I just sent to the mailing list.
I think the relish documentation is needed for users to try Pacto, so it should be in v0.3.0 (Usability).
The rubydoc is more for contributors (or at least advanced users) so it should be in v0.3.1 (Technical excellence).
from pacto.
Related Issues (20)
- Interaction matcher improvements
- distinction against pact HOT 1
- auto-negative tests
- Support for CSV and other formats HOT 3
- Media Type validation
- CLI Roadmap HOT 1
- add walkthrough of samples to documentation HOT 1
- request_clause headers need default value HOT 2
- Investigations are not run when stubbing a provider HOT 3
- clarify docs to emphasize that pacto is not concerned about server state HOT 2
- Handle compression
- NoMethodError: undefined method `each' for true:TrueClass HOT 3
- contracts.validate_all yields NoMethodError HOT 2
- Pacto Server Generate Command not working
- How to define a JSON body to be used in POST? it is missing in documentation
- Release 0.3.2 to rubygems? HOT 1
- Regular expressions in header matching
- Sharing contracts between client and server
- "TypeError: no implicit conversion of nil into Hash" when an example URI doesn't match request uri - templating issue
- Pacto Server CLI commands in readme do not exist
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pacto.