Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • A administrate
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 96
    • Issues 96
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 32
    • Merge requests 32
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • thoughtbot, inc.
  • administrate
  • Issues
  • #775
Closed
Open
Issue created Mar 10, 2017 by Administrator@rootContributor

Shipped gem should include documentation (guides)

Created by: fwolfst

Continuation from #503 (closed) , @nickcharlton seems to be positive about it too (https://github.com/thoughtbot/administrate/issues/503#issuecomment-285750224).

I opt for including the guides (in /doc) in the shipped gem. Although they are not necessary for usage, they provide means to access a proper high-level documentation independently from external services (like github, heroku, thoughbot) and internet connectivity.

While optimally the documentation might be included in the documentation that can automatically be built for the gem (rdoc), imho the markdown files are good enough.

Assignee
Assign to
Time tracking