add validation doc.go and move content from README.md there; fix typo

Author: estroz

README.md

@@ -6,14 +6,5 @@ Contains the API definitions used by [Operator Lifecycle Manager][olm] (OLM) and
 
 `pkg/validation` exposes a convenient set of interfaces to validate Kubernetes object manifests, primarily for use in an Operator project.
 
-Additionally this package defines a valid Operator [manifests format][registry-manifests] by exposing a set of `interfaces.Validator`'s to verify them and their constituent manifests. These bundles typically consist of a [Package Manifest][pkg-man] and a set of versioned [bundles][registry-manifests]. Each bundle contains a [ClusterServiceVersion][csv] and one or more [CustomResourceDefinition][crd]'s.
-
-This library reports errors and warnings for missing mandatory and optional fields, respectively. It also supports validation of `ClusterServiceVersion` YAML manifests for any data types inconsistent with those in OLM's [`ClusterServiceVersion`][csv-type] type.
-
 [olm]:https://github.com/operator-framework/operator-lifecycle-manager
 [marketplace]:https://github.com/operator-framework/operator-marketplace
-[registry-manifests]:https://github.com/operator-framework/operator-registry/#manifest-format
-[csv]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md
-[pkg-man]:https://github.com/operator-framework/operator-lifecycle-manager#discovery-catalogs-and-automated-upgrades
-[crd]:https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
-[csv-type]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go#L359:6

pkg/validation/doc.go

@@ -0,0 +1,15 @@
+// This package defines the valid Operator manifests directory format
+// by exposing a set of interfaces.Validator's to verify a directory and
+// its constituent manifests. A manifests directory consists of a
+// Package Manifest and a set of versioned Bundles. Each Bundle contains a
+// ClusterServiceVersion and one or more CustomResourceDefinition's.
+//
+// Errors and warnings, both represented by the errors.Error type, are
+// returned by exported functions for missing mandatory and optional fields,
+// respectively. Each Error implements the error interface.
+//
+// Manifest and Bundle format: https://github.com/operator-framework/operator-registry/#manifest-format
+// ClusterServiceVersion documentation: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md
+// Package manifest documentation: https://github.com/operator-framework/operator-lifecycle-manager#discovery-catalogs-and-automated-upgrades
+// CustomResourceDefinition documentation: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+package validation

pkg/validation/errors/error.go

@@ -59,7 +59,7 @@ type Error struct {
 	Detail string
 }
 
-// Error strut implements the 'error' interface to define custom error formatting.
+// Error implements the 'error' interface to define custom error formatting.
 func (e Error) Error() string {
 	detail := e.Detail
 	if detail != "" {