commit - 15c79f9461ab2d4a71b192444f6d658c39664377
commit + 75b1d88cd4d5e1b093168d967beba3cb605996f3
blob - 6b95e28795fc9e3e8f2bb4621dcd97a290462062
blob + 969c8e1bc93e94190b9970b7f73ca6062c47a0b1
--- jira/doc.go
+++ jira/doc.go
/*
-Jira is a program to interact with Jira issues from the Acme editor.
-Projects, issues and comments are presented as a virtual read-only filesystem
-(using package [io/fs])
-which can be browsed in the usual way Acme handles filesystems served
-by the host system.
+Package jira provides a virtual read-only filesystem interface to
+issues from a Jira issue tracker via the [Jira REST API]. Projects,
+issues and comments are presented as a files and directories from a
+filesystem implementing [fs.FS].
The filesystem root holds project directories.
Within each project are the project's issues, one directory entry per issue.
Comments are available as numbered files alongside the issue file.
Comment 69 of issue TEST-420 can be accessed at TEST/420/69.
-https:developer.atlassian.com/cloud/jira/platform/rest/v2/
-https:jira.atlassian.com/rest/api/2/issue/JRA-9
+[Jira REST API]: https://developer.atlassian.com/cloud/jira/platform/rest/v2/
*/
package jira